Class GroupEnt

Group实体类表示一组被组合在一起的实体，作为整体进行操作

Hierarchy (View Summary)

EntityBase
- GroupEnt

Constructors

constructor

new GroupEnt(name?: string, items?: any[]): GroupEnt
构造函数
Parameters
- name: string = ""
  组名称（原始实体类型名）
- items: any[] = []
  子实体数组
Returns GroupEnt
Overrides EntityBase.constructor
- Defined in entities/GroupEnt.ts:52

Properties

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

type

type: string

实体类型标识符（如"LINE"、"CIRCLE"等）

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

transformMatrix

get transformMatrix(): number[]
获取累积变换矩阵

Returns number[]
3x3 变换矩阵数组
- Defined in entities/GroupEnt.ts:67
set transformMatrix(value: number[]): void
设置累积变换矩阵
Parameters
- value: number[]
  3x3 变换矩阵数组
Returns void
- Defined in entities/GroupEnt.ts:75

name

get name(): string
获取组名称

Returns string
- Defined in entities/GroupEnt.ts:222
set name(value: string): void
设置组名称
Parameters
- value: string
Returns void
- Defined in entities/GroupEnt.ts:227

items

get items(): any[]
获取子实体数组

Returns any[]
- Defined in entities/GroupEnt.ts:233
set items(value: any[]): void
设置子实体数组
Parameters
- value: any[]
Returns void
- Defined in entities/GroupEnt.ts:238

count

get count(): number
获取子实体数量

Returns number
- Defined in entities/GroupEnt.ts:244

center

get center(): Point2D
获取组的中心点（边界框中心）用于夹点位置

Returns Point2D
- Defined in entities/GroupEnt.ts:252

Methods

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

mapToDbDefaultProps

mapToDbDefaultProps(targetDbObject: any): any
将属性映射到数据库默认属性对象

将当前实体的属性映射到数据库存储格式的对象中。用于保存实体数据到数据库或序列化。
Parameters
- targetDbObject: any
  目标数据库属性对象
Returns any
映射后的属性对象
Inherited from EntityBase.mapToDbDefaultProps
- Defined in entities/EntityBase.ts:609

setModified

setModified(): void
通知渲染系统此实体已被修改。在桶渲染模式下，这将标记对应的桶为"脏"，以便在下次 regenPartial 时重绘。注意：此方法只标记，不触发重绘。调用方需要在适当的时候（如命令结束时）调用 regenPartial()。

Returns void
Inherited from EntityBase.setModified
- Defined in entities/EntityBase.ts:655

isIdentityMatrix

isIdentityMatrix(): boolean
检查矩阵是否为单位矩阵

Returns boolean
是否为单位矩阵
- Defined in entities/GroupEnt.ts:86

resetTransformMatrix

resetTransformMatrix(): void
重置变换矩阵为单位矩阵

Returns void
- Defined in entities/GroupEnt.ts:100

addItem

addItem(entity: any): void
添加子实体
Parameters
- entity: any
  要添加的实体
Returns void
- Defined in entities/GroupEnt.ts:271

removeItem

removeItem(entity: any): void
移除子实体
Parameters
- entity: any
  要移除的实体
Returns void
- Defined in entities/GroupEnt.ts:280

clearItems

clearItems(): void
清空所有子实体

Returns void
- Defined in entities/GroupEnt.ts:291

move

move(fromPoint: PointInput, toPoint: PointInput): void
移动变换遍历所有子实体进行移动，并累积变换矩阵
Parameters
- fromPoint: PointInput
  起始点
- toPoint: PointInput
  目标点
Returns void
- Defined in entities/GroupEnt.ts:306

rotate

rotate(rotationCenter: PointInput, rotationAngle: number): void
旋转变换遍历所有子实体进行旋转，并累积变换矩阵
Parameters
- rotationCenter: PointInput
  旋转中心点
- rotationAngle: number
  旋转角度（弧度）
Returns void
- Defined in entities/GroupEnt.ts:333

scale

scale(scaleCenter: PointInput, scaleFactor: number): void
缩放变换遍历所有子实体进行缩放，并累积变换矩阵
Parameters
- scaleCenter: PointInput
  缩放中心点
- scaleFactor: number
  缩放因子
Returns void
- Defined in entities/GroupEnt.ts:357

mirror

mirror(mirrorAxisStart: PointInput, mirrorAxisEnd: PointInput): void
镜像变换遍历所有子实体进行镜像，并累积变换矩阵
Parameters
- mirrorAxisStart: PointInput
  镜像轴起点
- mirrorAxisEnd: PointInput
  镜像轴终点
Returns void
Overrides EntityBase.mirror
- Defined in entities/GroupEnt.ts:381

stretch

stretch(
    stretchStartPoint: PointInput,
    stretchEndPoint: PointInput,
    stretchBox: BoundingBox,
): void
拉伸变换遍历所有子实体进行拉伸
Parameters
- stretchStartPoint: PointInput
  拉伸起始点
- stretchEndPoint: PointInput
  拉伸目标点
- stretchBox: BoundingBox
  拉伸框
Returns void
- Defined in entities/GroupEnt.ts:410

gripEdit

gripEdit(newGripPosition: Point2D, gripType: string): void
夹点编辑通过拖拽夹点来移动整个组
Parameters
- newGripPosition: Point2D
  新的夹点位置
- gripType: string
  夹点类型标识符
Returns void
- Defined in entities/GroupEnt.ts:427

boundingBox

boundingBox(coordinateSystemType?: number): BoundingBox
计算边界框合并所有子实体的边界框
Parameters
- coordinateSystemType: number = CoordinateSystemType.WCS
  坐标系类型
Returns BoundingBox
组的边界框
- Defined in entities/GroupEnt.ts:444

allPointsWithInBox

allPointsWithInBox(boundingBox: BoundingBox): boolean
检查所有点是否在指定边界框内
Parameters
- boundingBox: BoundingBox
  边界框
Returns boolean
是否所有点都在边界框内
- Defined in entities/GroupEnt.ts:464

explode

explode(): any[]
炸开组返回所有子实体的克隆副本

Returns any[]
子实体数组（克隆）
- Defined in entities/GroupEnt.ts:484

getItems

getItems(): any[]
获取子实体数组（用于渲染等场景）

Returns any[]
子实体数组引用
- Defined in entities/GroupEnt.ts:504

clone

clone(): GroupEnt
克隆组对象

Returns GroupEnt
克隆的组对象
- Defined in entities/GroupEnt.ts:516

toDb

toDb(): any
转换为数据库对象

Returns any
数据库格式的组对象
- Defined in entities/GroupEnt.ts:543

fromDb

fromDb(dbData: any, entityFactory?: (dbEntity: any) => any): void
从数据库对象加载注意：子实体需要通过CadDocument.createEntityFromDbData创建
Parameters
- dbData: any
  数据库格式的组数据
- OptionalentityFactory: (dbEntity: any) => any
  实体工厂函数，用于创建子实体
Returns void
- Defined in entities/GroupEnt.ts:574

undoMap

undoMap(backupGroup: GroupEnt): void
撤销映射从备份对象恢复组的所有属性
Parameters
- backupGroup: GroupEnt
  备份的组对象
Returns void
- Defined in entities/GroupEnt.ts:613

repairStretch

repairStretch(backupGroup: GroupEnt): void
修复拉伸从备份对象恢复拉伸前的状态
Parameters
- backupGroup: GroupEnt
  备份的组对象
Returns void
- Defined in entities/GroupEnt.ts:631

dispose

dispose(): void
释放资源

Returns void
Overrides EntityBase.dispose
- Defined in entities/GroupEnt.ts:640

Class GroupEnt

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GroupEnt

Properties

objectId

id

_lineType

_isAlive

isDirty

Optionalblock

type

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

transformMatrix

Returns number[]

Parameters

Returns void

name

Returns string

Parameters

Returns void

items

Returns any[]

Parameters

Returns void

count

Returns number

center

Returns Point2D

Methods

`Optional`block