Class CustomEntityBase`Abstract`

自定义实体基类

所有插件自定义实体都应继承此类，并实现所有抽象方法。

Hierarchy (View Summary)

EntityBase
- CustomEntityBase
  - DimensionBase
  - MLeaderEnt

Constructors

constructor

new CustomEntityBase(): CustomEntityBase
构造函数

Returns CustomEntityBase
Overrides EntityBase.constructor
- Defined in entities/CustomEntityBase.ts:180

Properties

`Readonly`type

type: string = "CUSTOM"

实体类型标识（固定为 "CUSTOM"）

`Abstract` `Readonly`customType

customType: string

自定义实体类型标识子类必须设置此属性以标识具体的自定义实体类型例如: "ANGLE_DIMENSION", "CUSTOM_HATCH" 等

`Abstract` `Readonly`customDisplayName

customDisplayName: string

自定义实体显示名称子类必须设置此属性以提供在属性栏中显示的名称例如: customType为"ANGLE_DIMENSION"时，displayName为"角度标注" 属性栏显示时会自动截断过长内容并显示"..."

`Protected`_nestEntsCache

_nestEntsCache: EntityBase[] = null

嵌套实体缓存用于避免重复生成嵌套实体，提高渲染性能

objectId

objectId: string

DWG对象ID（句柄）- 从DWG文件导入时的唯一标识符这个值不应该在克隆时复制，新创建的实体应该为空字符串

id

id: number

实体索引ID - 从1开始递增的唯一索引用于在WebCAD格式中标识实体

_lineType

_lineType: string

_isAlive

_isAlive: boolean

isDirty

isDirty: boolean

是否处于脏状态，供渲染器增量更新

`Optional`block

block?: any

Accessors

color

get color(): number
获取颜色索引

Returns number
颜色索引值（256表示"随图层"颜色）
Inherited from EntityBase.color
- Defined in entities/EntityBase.ts:116
set color(value: number): void
设置颜色索引
Parameters
- value: number
  颜色索引值（256表示"随图层"颜色）
Returns void
Inherited from EntityBase.color
- Defined in entities/EntityBase.ts:125

layerId

get layerId(): string
获取图层ID

Returns string
图层ID字符串
Inherited from EntityBase.layerId
- Defined in entities/EntityBase.ts:137
set layerId(value: string): void
设置图层ID
Parameters
- value: string
  图层ID字符串
Returns void
Inherited from EntityBase.layerId
- Defined in entities/EntityBase.ts:146

lineTypeScale

get lineTypeScale(): number
获取线型比例

Returns number
线型比例因子
Inherited from EntityBase.lineTypeScale
- Defined in entities/EntityBase.ts:158
set lineTypeScale(value: number): void
设置线型比例
Parameters
- value: number
  线型比例因子
Returns void
Inherited from EntityBase.lineTypeScale
- Defined in entities/EntityBase.ts:167

lineWeight

get lineWeight(): number
获取线宽

Returns number
线宽值（-1=ByLayer, -2=ByBlock, >=0为具体值，单位为0.01mm）
Inherited from EntityBase.lineWeight
- Defined in entities/EntityBase.ts:179
set lineWeight(value: number): void
设置线宽
Parameters
- value: number
  线宽值（-1=ByLayer, -2=ByBlock, >=0为具体值）
Returns void
Inherited from EntityBase.lineWeight
- Defined in entities/EntityBase.ts:188

transpMgr

get transpMgr(): TransparencyManager
获取透明度管理器

Returns TransparencyManager
透明度管理器实例
Inherited from EntityBase.transpMgr
- Defined in entities/EntityBase.ts:200
set transpMgr(value: TransparencyManager): void
设置透明度管理器
Parameters
- value: TransparencyManager
  透明度管理器实例
Returns void
Inherited from EntityBase.transpMgr
- Defined in entities/EntityBase.ts:209

isAlive

get isAlive(): boolean
获取实体存活状态

Returns boolean
是否存活（true表示有效，false表示已删除）
Inherited from EntityBase.isAlive
- Defined in entities/EntityBase.ts:219
set isAlive(value: boolean): void
设置实体存活状态
Parameters
- value: boolean
  是否存活
Returns void
Inherited from EntityBase.isAlive
- Defined in entities/EntityBase.ts:228

xdataRaw

get xdataRaw(): Record<string, string>
获取原始扩展数据（用于序列化）格式: { "1001": "AppName", "1000": "JSON字符串" }

Returns Record<string, string>
原始xdata对象或undefined
Inherited from EntityBase.xdataRaw
- Defined in entities/EntityBase.ts:242
set xdataRaw(value: Record<string, string>): void
设置原始扩展数据（从数据库加载时使用）
Parameters
- value: Record<string, string>
  原始xdata对象
Returns void
Inherited from EntityBase.xdataRaw
- Defined in entities/EntityBase.ts:251

extData

get extData(): Record<string, any>
获取扩展数据（用户友好格式）自动解析JSON字符串返回对象

Returns Record<string, any>
解析后的扩展数据对象，或undefined
Example
```
const data = entity.extData;
console.log(data?.sensorVal); // 10
```
Inherited from EntityBase.extData
- Defined in entities/EntityBase.ts:267

extDataAppName

get extDataAppName(): string
获取扩展数据的应用程序名（AppName）

Returns string
AppName字符串，或undefined
Inherited from EntityBase.extDataAppName
- Defined in entities/EntityBase.ts:281

doc

get doc(): any
获取所属文档

通过实体所在的块来获取文档对象。在CAD系统中，实体总是属于某个块，而块又属于某个文档。

Returns any
文档对象，如果无法获取则返回undefined
Inherited from EntityBase.doc
- Defined in entities/EntityBase.ts:337

layer

get layer(): string
获取图层名称

根据实体的layerId从文档的图层集合中查找对应的图层名称。如果找不到对应的图层，则返回默认图层"0"。

Returns string
图层名称，默认为"0"
Inherited from EntityBase.layer
- Defined in entities/EntityBase.ts:350
set layer(layerName: string): void
设置图层名称

根据图层名称查找对应的图层ID并设置给实体。如果找不到指定的图层，则使用默认图层ID（"0"）。

注意：优先使用实体所属文档的图层列表，如果实体尚未添加到文档，则使用 Engine.currentDoc 的图层列表。
Parameters
- layerName: string
  图层名称
Returns void
Inherited from EntityBase.layer
- Defined in entities/EntityBase.ts:367

lineType

get lineType(): string
获取线型

返回实体当前的线型设置。线型控制线条的显示样式（如实线、虚线、点划线等）。

Returns string
线型名称
Inherited from EntityBase.lineType
- Defined in entities/EntityBase.ts:384
set lineType(lineTypeName: string): void
设置线型

设置实体的线型，支持标准CAD线型、常见别名和自定义线型。输入的线型名称会被转换为大写进行匹配。

支持的线型：
- CONTINUOUS: 连续线（实线）
- HIDDEN/DASHED: 虚线（虚线）
- CENTER: 中心线
- PHANTOM: 幻影线
- DOT: 点线（映射为虚线）
- 自定义线型：通过LinetypeManager管理的线型
Parameters
- lineTypeName: string
  线型名称
Returns void
Inherited from EntityBase.lineType
- Defined in entities/EntityBase.ts:405

Methods

`Abstract`getSnapPoints

getSnapPoints(): SnapPointResult[]

获取捕捉点

返回实体上可以被对象捕捉识别的点。用于绘图时的精确定位。

Returns SnapPointResult[]

捕捉点数组

Example

getSnapPoints(): SnapPointResult[] {
  return [
    { point: this.startPoint, type: 'endpoint' },
    { point: this.endPoint, type: 'endpoint' },
    { point: this.midPoint, type: 'midpoint' }
  ];
}

`Abstract`getGripPoints

getGripPoints(): GripPointResult[]

获取夹点

返回实体上可以被拖拽编辑的点。用于夹点编辑功能。

Returns GripPointResult[]

夹点数组

Example

getGripPoints(): GripPointResult[] {
  return [
    { point: this.startPoint, gripId: 'start', type: 'stretch' },
    { point: this.center, gripId: 'center', type: 'move' }
  ];
}

explode

explode(): EntityBase[]
炸开实体

将自定义实体分解为基本图元（线、圆弧等）。用于分解命令和DXF导出。

子类可以重写此方法以提供自定义的炸开逻辑。如果不重写，默认使用 getNestEnts() 返回的实体进行炸开。

Returns EntityBase[]
炸开后的基本实体数组
Example
```
explode(): EntityBase[] {
  const line1 = new LineEnt(this.point1, this.point2);
  const arc = new ArcEnt(this.center, this.radius, this.startAng, this.endAng);
  return [line1, arc];
}
```
- Defined in entities/CustomEntityBase.ts:244

`Protected` `Abstract`buildNestEnts

buildNestEnts(): EntityBase[]
构建嵌套实体（由子类实现）

返回组成该自定义实体的子实体，用于渲染显示。与explode不同，这里返回的实体不需要独立存在，主要用于渲染器绘制自定义实体的视觉效果。

子类必须实现此方法来生成实际的嵌套实体。

缓存机制
此方法的返回值会被基类缓存（通过 getNestEnts() 调用）。当实体被修改（调用 setModified()）时，缓存会自动清除。下次调用 getNestEnts() 时会重新调用 buildNestEnts() 生成新的实体。

重要约束：禁止克隆文本实体
在实现此方法时，不允许克隆文本实体（MTextEnt/TextEnt）！

原因：文本实体的坐标是在渲染时动态计算和更新的。如果克隆文本实体，会导致：
- 原始文本对象的坐标永远是初始值（如 0,0）
- 边界框计算错误
- 其他依赖文本坐标的功能异常
正确做法是直接将类内部的文本对象（如 _dimText）添加到实体数组中：
```
// 错误示例 - 不要这样做：
const textClone = this._dimText.clone();
entities.push(textClone);

// 正确示例：
if (this._dimText) {
  this._dimText.fromDefaultProps(this);
  entities.push(this._dimText);
}
```
Returns EntityBase[]
嵌套实体数组
- Defined in entities/CustomEntityBase.ts:290

getNestEnts

getNestEnts(): EntityBase[]
获取嵌套实体（带缓存）

返回组成该自定义实体的子实体，用于渲染显示。

缓存机制
此方法使用内部缓存来避免重复生成嵌套实体，提高渲染性能：
- 如果缓存有效，直接返回缓存的实体数组
- 如果缓存无效（为 null），调用 buildNestEnts() 生成新实体并缓存
- 当实体被修改（调用 setModified()）时，缓存自动清除
子类如需重写此方法（如需支持额外参数），应注意正确处理缓存逻辑。
Returns EntityBase[]
嵌套实体数组
- Defined in entities/CustomEntityBase.ts:308

`Protected`clearNestEntsCache

clearNestEntsCache(): void
清除嵌套实体缓存

在需要强制重新生成嵌套实体时调用。通常在setModified时会自动调用。

Returns void
- Defined in entities/CustomEntityBase.ts:325

boundingBox

boundingBox(coordinateSystemType?: CoordinateSystemType): BoundingBox
计算边界框

默认实现：根据 getNestEnts() 返回的子实体计算合并边界框。子类可以重写此方法以提供自定义的边界框计算逻辑。
Parameters
- coordinateSystemType: CoordinateSystemType = CoordinateSystemType.WCS
  坐标系类型
Returns BoundingBox
边界框
- Defined in entities/CustomEntityBase.ts:338

`Abstract`clone

clone(): CustomEntityBase
克隆实体

Returns CustomEntityBase
克隆的实体
- Defined in entities/CustomEntityBase.ts:361

toDb

toDb(): CustomEntityDbData
转换为数据库格式

将实体序列化为可存储的数据格式。默认实现会包含嵌套实体数据用于DWG导出。子类可以重写此方法以提供自定义序列化逻辑。

Returns CustomEntityDbData
数据库格式对象
- Defined in entities/CustomEntityBase.ts:372

mapToDbDefaultProps

mapToDbDefaultProps(targetDbObject: any): any
将属性映射到数据库默认属性对象（重写父类方法）

除了调用父类的基础属性映射外，还会序列化嵌套实体用于DWG导出。
Parameters
- targetDbObject: any
  目标数据库属性对象
Returns any
映射后的属性对象
Overrides EntityBase.mapToDbDefaultProps
- Defined in entities/CustomEntityBase.ts:393

`Abstract`fromDb

fromDb(dbData: CustomEntityDbData): void
从数据库格式恢复

从序列化数据恢复实体状态。
Parameters
- dbData: CustomEntityDbData
  数据库格式数据
Returns void
- Defined in entities/CustomEntityBase.ts:420

`Abstract`getEntityData

getEntityData(): any
获取自定义实体的特定数据

子类应重写此方法返回需要序列化的自定义数据。

Returns any
自定义实体数据对象
- Defined in entities/CustomEntityBase.ts:429

`Abstract`setEntityData

setEntityData(data: any): void
从自定义实体数据恢复

子类应重写此方法从自定义数据恢复实体状态。
Parameters
- data: any
  自定义实体数据对象
Returns void
- Defined in entities/CustomEntityBase.ts:438

getPropertyInfo

getPropertyInfo(): PropertyInfo[]

获取属性面板信息

返回用于在属性面板中显示的属性信息。子类可以重写此方法以提供自定义属性显示。

Returns PropertyInfo[]

属性信息数组

Example

getPropertyInfo(): PropertyInfo[] {
  return [
    { 
      label: '角度', 
      value: this.angle.toFixed(2) + '°',
      editable: true,
      onChange: (newValue) => { this.angle = parseFloat(newValue); }
    },
    { 
      label: '顶点', 
      value: `(${this.vertex.x.toFixed(2)}, ${this.vertex.y.toFixed(2)})`,
      editable: false
    }
  ];
}

getDisplayName

getDisplayName(maxLength?: number): string
获取属性面板显示名称

返回在属性面板中显示的实体名称。超过指定长度的内容将被截断并显示"..."
Parameters
- maxLength: number = 20
  最大显示长度，默认为20
Returns string
显示名称
- Defined in entities/CustomEntityBase.ts:491

gripEdit

gripEdit(newPosition: Point2D, gripId: string): void
夹点编辑

响应夹点拖拽操作。子类应根据gripId识别不同的夹点。
Parameters
- newPosition: Point2D
  新的夹点位置
- gripId: string
  夹点标识符
Returns void
- Defined in entities/CustomEntityBase.ts:511

allPointsWithInBox

allPointsWithInBox(box: BoundingBox): boolean
检查所有关键点是否在边界框内
Parameters
- box: BoundingBox
  边界框
Returns boolean
是否所有点都在边界框内
- Defined in entities/CustomEntityBase.ts:529

undoMap

undoMap(backup: CustomEntityBase): void
撤销映射

从备份对象恢复实体状态。
Parameters
- backup: CustomEntityBase
  备份的实体对象
Returns void
- Defined in entities/CustomEntityBase.ts:547

repairStretch

repairStretch(backup: CustomEntityBase): void
修复拉伸
Parameters
- backup: CustomEntityBase
  备份的实体对象
Returns void
- Defined in entities/CustomEntityBase.ts:557

setModified

setModified(): void
标记实体已修改

重写父类方法，在标记修改时同时清除嵌套实体缓存。

Returns void
Overrides EntityBase.setModified
- Defined in entities/CustomEntityBase.ts:570

move

move(fromPoint: PointInput, toPoint: PointInput): void
移动变换

默认实现：移动所有夹点。子类可重写以实现自定义移动逻辑。
Parameters
- fromPoint: PointInput
  起始点
- toPoint: PointInput
  目标点
Returns void
- Defined in entities/CustomEntityBase.ts:585

rotate

rotate(centerPoint: PointInput, angle: number): void
旋转变换
Parameters
- centerPoint: PointInput
  旋转中心
- angle: number
  旋转角度（弧度）
Returns void
- Defined in entities/CustomEntityBase.ts:596

scale

scale(centerPoint: PointInput, factor: number): void
缩放变换
Parameters
- centerPoint: PointInput
  缩放中心
- factor: number
  缩放因子
Returns void
- Defined in entities/CustomEntityBase.ts:607

mirror

mirror(mirrorAxisStart: PointInput, mirrorAxisEnd: PointInput): void
镜像变换
Parameters
- mirrorAxisStart: PointInput
  镜像轴起点
- mirrorAxisEnd: PointInput
  镜像轴终点
Returns void
Overrides EntityBase.mirror
- Defined in entities/CustomEntityBase.ts:618

stretch

stretch(
    fromPoint: PointInput,
    toPoint: PointInput,
    stretchBox: BoundingBox,
): void
拉伸变换
Parameters
- fromPoint: PointInput
  拉伸起点
- toPoint: PointInput
  拉伸终点
- stretchBox: BoundingBox
  拉伸框
Returns void
- Defined in entities/CustomEntityBase.ts:630

setExtData

setExtData(appName: string, data: Record<string, any>): void
设置扩展数据（用户友好格式）自动将对象序列化为JSON字符串存储
Parameters
- appName: string
  应用程序名（用于在DWG中标识数据来源）
- data: Record<string, any>
  要存储的数据对象（将被序列化为JSON）
Returns void
Example
```
entity.setExtData("MY_SENSOR", {
  sensorVal: 10,
  deviceName: "温度传感器",
  isActive: true
});
```
Inherited from EntityBase.setExtData
- Defined in entities/EntityBase.ts:300

clearExtData

clearExtData(): void
清除扩展数据

Returns void
Inherited from EntityBase.clearExtData
- Defined in entities/EntityBase.ts:312

hasExtData

hasExtData(): boolean
检查是否有扩展数据

Returns boolean
是否存在扩展数据
Inherited from EntityBase.hasExtData
- Defined in entities/EntityBase.ts:322

fromDefaultProps

fromDefaultProps(defaultPropsObject: any): this
从默认属性对象复制属性

将指定的默认属性对象的所有相关属性复制到当前实体。这通常用于创建新实体时应用默认设置。
Parameters
- defaultPropsObject: any
  默认属性对象，包含layer、colorIndex、lineType等属性
Returns this
当前实例（支持链式调用）
Inherited from EntityBase.fromDefaultProps
- Defined in entities/EntityBase.ts:469

setDefaults

setDefaults(): void
设置为系统默认值

从全局CAD系统设置中获取当前的默认属性值并应用到实体。这些默认值包括当前图层、当前颜色、当前线型等。

使用的全局变量：
- Engine.currentDoc.CLAYER: 当前图层名称
- Engine.CECOLOR: 当前实体颜色
- Engine.CELTYPE: 当前实体线型
- Engine.CELTSCALE: 当前实体线型比例
Returns void
Inherited from EntityBase.setDefaults
- Defined in entities/EntityBase.ts:531

fromDbDefaultProps

fromDbDefaultProps(dbPropsObject: any): this
从数据库默认属性对象设置属性

从数据库查询结果或序列化数据中恢复实体属性。这个方法处理数据库中可能存在的空值和默认值情况。
Parameters
- dbPropsObject: any
  数据库属性对象，包含layerId、colorIndex等属性
Returns this
当前实例（支持链式调用）
Inherited from EntityBase.fromDbDefaultProps
- Defined in entities/EntityBase.ts:551

dispose

dispose(): void
释放实体占用的外部资源子类如持有 PIXI 对象或大尺寸缓冲，应覆盖此方法清理

Returns void
Inherited from EntityBase.dispose
- Defined in entities/EntityBase.ts:671

Class CustomEntityBaseAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CustomEntityBase

Properties

Readonlytype

Abstract ReadonlycustomType

Abstract ReadonlycustomDisplayName

Protected_nestEntsCache

objectId

id

_lineType

_isAlive

isDirty

Optionalblock

Accessors

color

Returns number

Parameters

Returns void

layerId

Returns string

Parameters

Returns void

lineTypeScale

Returns number

Parameters

Returns void

lineWeight

Returns number

Parameters

Returns void

transpMgr

Returns TransparencyManager

Parameters

Returns void

isAlive

Returns boolean

Parameters

Returns void

xdataRaw

Returns Record<string, string>

Parameters

Returns void

extData

Returns Record<string, any>

Example

extDataAppName

Returns string

doc

Returns any

layer

Returns string

Parameters

Returns void

lineType

Returns string

Parameters

Returns void

Methods

AbstractgetSnapPoints

Returns SnapPointResult[]

Example

AbstractgetGripPoints

Returns GripPointResult[]

Example

explode

Returns EntityBase[]

Example

Protected AbstractbuildNestEnts

缓存机制

重要约束：禁止克隆文本实体

Returns EntityBase[]

getNestEnts

Class CustomEntityBase`Abstract`

`Readonly`type

`Abstract` `Readonly`customType

`Abstract` `Readonly`customDisplayName

`Protected`_nestEntsCache

`Optional`block

`Abstract`getSnapPoints

`Abstract`getGripPoints

`Protected` `Abstract`buildNestEnts

`Protected`clearNestEntsCache

`Abstract`clone

`Abstract`fromDb

`Abstract`getEntityData

`Abstract`setEntityData