Class HatchEnt

填充类表示CAD中的填充实体，支持多种填充图案

Example

import { HatchEnt, Engine } from '@aspect/webcad-lib-ts';

// 创建填充实体
const hatch = new HatchEnt();
hatch.patternName = "ANSI31";
hatch.setDefaults();
Engine.addEntities(hatch);

Hierarchy (View Summary)

EntityBase
- HatchEnt

Index

Constructors

constructor

Properties

type objectId id _lineType _isAlive isDirty block? patternEnts _regenFlag _patternRenderer?

Constructors

constructor

new HatchEnt(): HatchEnt
Returns HatchEnt
Overrides EntityBase.constructor
- Defined in entities/HatchEnt.ts:110

Properties

type

type: string

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

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

patternEnts

patternEnts: GLine[]

_regenFlag

_regenFlag: boolean

`Optional`_patternRenderer

_patternRenderer?: 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

globalWidth

get globalWidth(): number
Returns number
- Defined in entities/HatchEnt.ts:132
set globalWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in entities/HatchEnt.ts:136

isClosed

get isClosed(): boolean
Returns boolean
- Defined in entities/HatchEnt.ts:141
set isClosed(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in entities/HatchEnt.ts:145

bulgePoints

get bulgePoints(): BulgePoints
Returns BulgePoints
- Defined in entities/HatchEnt.ts:151
set bulgePoints(value: BulgePoints): void
Parameters
- value: BulgePoints
Returns void
- Defined in entities/HatchEnt.ts:155

loops

get loops(): Edges
Returns Edges
- Defined in entities/HatchEnt.ts:163
set loops(value: Edges): void
Parameters
- value: Edges
Returns void
- Defined in entities/HatchEnt.ts:167

patternName

get patternName(): string
Returns string
- Defined in entities/HatchEnt.ts:173
set patternName(value: string): void
Parameters
- value: string
Returns void
- Defined in entities/HatchEnt.ts:177

patternCross

get patternCross(): boolean
Returns boolean
- Defined in entities/HatchEnt.ts:183
set patternCross(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in entities/HatchEnt.ts:187

patternScale

get patternScale(): number
Returns number
- Defined in entities/HatchEnt.ts:193
set patternScale(value: number): void
Parameters
- value: number
Returns void
- Defined in entities/HatchEnt.ts:197

patternSpace

get patternSpace(): number
Returns number
- Defined in entities/HatchEnt.ts:203
set patternSpace(value: number): void
Parameters
- value: number
Returns void
- Defined in entities/HatchEnt.ts:207

origin

get origin(): Point2D
Returns Point2D
- Defined in entities/HatchEnt.ts:213
set origin(value: Point2D): void
Parameters
- value: Point2D
Returns void
- Defined in entities/HatchEnt.ts:217

patternAngle

get patternAngle(): number
获取图案角度

Returns number
角度值
- Defined in entities/HatchEnt.ts:227
set patternAngle(angleValue: number): void
设置图案角度
Parameters
- angleValue: number
  角度值
Returns void
- Defined in entities/HatchEnt.ts:235

regenFlag

get regenFlag(): boolean
获取重新生成标志

Returns boolean
是否需要重新生成
- Defined in entities/HatchEnt.ts:254

fillLoopsCache

get fillLoopsCache(): FillLoopData[]
获取填充循环缓存

Returns FillLoopData[]
- Defined in entities/HatchEnt.ts:269
set fillLoopsCache(value: FillLoopData[]): void
设置填充循环缓存
Parameters
- value: FillLoopData[]
Returns void
- Defined in entities/HatchEnt.ts:276

startBulgePoint

get startBulgePoint(): any
获取起始凸度点

Returns any
起始凸度点
- Defined in entities/HatchEnt.ts:816

endBulgePoint

get endBulgePoint(): any
获取结束凸度点

Returns any
结束凸度点
- Defined in entities/HatchEnt.ts:826

subEnts

get subEnts(): (ArcEnt | LineEnt | CircleEnt | EllipseEnt)[]
Returns (ArcEnt | LineEnt | CircleEnt | EllipseEnt)[]
- Defined in entities/HatchEnt.ts:1222

subGeometries

get subGeometries(): SubGeometry[]
获取填充的轻量级几何体集合（用于几何计算和渲染）

与 subEnts 不同，此方法返回轻量级几何对象（GLine、GArc、GCircle、GEllipse），不包含实体属性（颜色、图层等），减少内存占用和计算开销。支持缓存，通过 Engine.ENABLE_GEOMETRY_CACHE 控制。

Returns SubGeometry[]
轻量级几何体数组
- Defined in entities/HatchEnt.ts:1283

Length

get Length(): number
Returns number
- Defined in entities/HatchEnt.ts:1387

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

dispose

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

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

getRawBulgePoints

getRawBulgePoints(): BulgePoints
Returns BulgePoints
- Defined in entities/HatchEnt.ts:245

setRegenFrag

setRegenFrag(): void
设置重新生成标志，并清除填充循环缓存

Returns void
- Defined in entities/HatchEnt.ts:261

clearRegenFrag

clearRegenFrag(): void
清除重新生成标志

Returns void
- Defined in entities/HatchEnt.ts:283

regenPattern

regenPattern(applyProperties?: boolean): GLine[]
重新生成填充图案根据图案名称生成对应的填充线条
Parameters
- applyProperties: boolean = true
  是否应用默认属性，默认为true（保留参数以保持接口兼容，但GLine不使用此属性）
Returns GLine[]
生成的图案实体数组
- Defined in entities/HatchEnt.ts:293

setPatternPerformanceOptions

setPatternPerformanceOptions(options: any): void
设置填充图案性能选项
Parameters
- options: any
  性能选项
Returns void
- Defined in entities/HatchEnt.ts:507

getPatternStatistics

getPatternStatistics(): any
获取填充算法统计信息

Returns any
统计信息
- Defined in entities/HatchEnt.ts:519

validateCurrentPattern

validateCurrentPattern(): { valid: boolean; errors: string[] }
验证当前图案定义

Returns { valid: boolean; errors: string[] }
验证结果
- Defined in entities/HatchEnt.ts:531

getPatternEnts

getPatternEnts(): GLine[]
获取图案实体

Returns GLine[]
图案实体数组
- Defined in entities/HatchEnt.ts:554

getPatternInterval

getPatternInterval(): number
获取图案间隔从图案定义中获取正确的间隔值

Returns number
图案间隔
- Defined in entities/HatchEnt.ts:564

setLoops

setLoops(edgesCollection: Edges): void
设置边界循环自动处理：Circle/Ellipse 类型自动生成 bulgePoints，自动设置闭合
Parameters
- edgesCollection: Edges
  边界循环集合
Returns void
- Defined in entities/HatchEnt.ts:618

regenLoop

regenLoop(): void
重新生成循环触发填充图案重新生成

Returns void
- Defined in entities/HatchEnt.ts:637

boundingBox

boundingBox(coordinateSystemType?: CoordinateSystemType): BoundingBox
获取边界框
Parameters
- coordinateSystemType: CoordinateSystemType = CoordinateSystemType.WCS
  坐标系类型，默认为WCS
Returns BoundingBox
边界框
- Defined in entities/HatchEnt.ts:648

getBoundsDcs

getBoundsDcs(): BoundingBox
获取DCS坐标系下的边界

Returns BoundingBox
DCS坐标系下的边界框
- Defined in entities/HatchEnt.ts:699

getBoundsUcs

getBoundsUcs(): BoundingBox
获取UCS坐标系下的边界

Returns BoundingBox
UCS坐标系下的边界框
- Defined in entities/HatchEnt.ts:707

getBounds

getBounds(coordinateSystem?: string): BoundingBox
获取指定坐标系下的边界
Parameters
- coordinateSystem: string = "Wcs"
  坐标系类型，默认为"Wcs"
Returns BoundingBox
边界框
- Defined in entities/HatchEnt.ts:716

pointIsInBulgePoints

pointIsInBulgePoints(
testPoint: Point2D,
bulgePointsCollection: BulgePoints,
): boolean
检查点是否在凸度点集合内使用射线法判断点是否在多边形内部
Parameters
- testPoint: Point2D
  要检查的点
- bulgePointsCollection: BulgePoints
  凸度点集合
Returns boolean
是否在内部
- Defined in entities/HatchEnt.ts:765

allPointsWithInBox

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

mirror

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

move

move(fromPoint: PointInput, toPoint: PointInput): void
移动变换
Parameters
- fromPoint: PointInput
  起始点
- toPoint: PointInput
  目标点
Returns void
- Defined in entities/HatchEnt.ts:885

rotate

rotate(
    rotationCenter: PointInput,
    rotationAngle: number,
    shouldSetRegenFlag?: boolean,
): void
旋转变换
Parameters
- rotationCenter: PointInput
  旋转中心
- rotationAngle: number
  旋转角度
- shouldSetRegenFlag: boolean = true
  是否设置重新生成标志，默认为true
Returns void
- Defined in entities/HatchEnt.ts:928

scale

scale(scaleCenter: PointInput, scaleFactor: number): void
缩放变换
Parameters
- scaleCenter: PointInput
  缩放中心
- scaleFactor: number
  缩放因子
Returns void
- Defined in entities/HatchEnt.ts:974

stretch

stretch(
    fromPoint: PointInput,
    toPoint: PointInput,
    stretchBox: BoundingBox,
): void
Parameters
- fromPoint: PointInput
- toPoint: PointInput
- stretchBox: BoundingBox
Returns void
- Defined in entities/HatchEnt.ts:1013

repairStretch

repairStretch(sourceHatch: HatchEnt): void
Parameters
- sourceHatch: HatchEnt
Returns void
- Defined in entities/HatchEnt.ts:1064

getSubEnts

getSubEnts(): (ArcEnt | LineEnt | CircleEnt | EllipseEnt)[]
Returns (ArcEnt | LineEnt | CircleEnt | EllipseEnt)[]
- Defined in entities/HatchEnt.ts:1069

getPolygonVertices

getPolygonVertices(arcSegments?: number): number[][][]
获取多边形顶点数组（用于新的填充渲染器）将包含凸度的边界转换为离散的多边形顶点
Parameters
- arcSegments: number = 128
  圆弧离散化的段数，默认128
Returns number[][][]
多边形顶点数组 [[x1, y1], [x2, y2], ...]
- Defined in entities/HatchEnt.ts:1079

discretizeArc

discretizeArc(
    startPoint: Point2D,
    endPoint: Point2D,
    bulge: number,
    segments: number,
): number[][]
将圆弧离散化为多个点

基于AutoCAD的bulge定义：
- bulge = tan(sweepAngle / 4)
- 正bulge：逆时针圆弧（CCW）
- 负bulge：顺时针圆弧（CW）
Parameters
- startPoint: Point2D
  起点
- endPoint: Point2D
  终点
- bulge: number
  凸度值
- segments: number
  离散化段数
Returns number[][]
离散化后的点数组
- Defined in entities/HatchEnt.ts:1135

clearGeometryCache

clearGeometryCache(): void
清除几何缓存

Returns void
- Defined in entities/HatchEnt.ts:1340

setModified

setModified(): void
重写 setModified 以清除几何缓存

Returns void
Overrides EntityBase.setModified
- Defined in entities/HatchEnt.ts:1347

getLoopEnts

getLoopEnts(): (PolylineEnt | CircleEnt | EllipseEnt)[]
Returns (PolylineEnt | CircleEnt | EllipseEnt)[]
- Defined in entities/HatchEnt.ts:1352

gripEdit

gripEdit(newPoint: Point2D, gripId: string): void
Parameters
- newPoint: Point2D
- gripId: string
Returns void
- Defined in entities/HatchEnt.ts:1395

gripEdit_Mid

gripEdit_Mid(newMidPoint: Point2D, gripId: string): void
Parameters
- newMidPoint: Point2D
- gripId: string
Returns void
- Defined in entities/HatchEnt.ts:1428

undoMap

undoMap(sourceHatch: HatchEnt): void
Parameters
- sourceHatch: HatchEnt
Returns void
- Defined in entities/HatchEnt.ts:1480

clone

clone(): HatchEnt
Returns HatchEnt
- Defined in entities/HatchEnt.ts:1495

toDb

toDb(): DbHatch
Returns DbHatch
- Defined in entities/HatchEnt.ts:1511

fromDb

fromDb(dbHatch: DbHatch): void
Parameters
- dbHatch: DbHatch
Returns void
- Defined in entities/HatchEnt.ts:1529

Class HatchEnt

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HatchEnt

Properties

type

objectId

id

_lineType

_isAlive

isDirty

Optionalblock

patternEnts

_regenFlag

Optional_patternRenderer

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

globalWidth

Returns number

Parameters

Returns void

isClosed

Returns boolean

Parameters

Returns void

bulgePoints

Returns BulgePoints

Parameters

Returns void

loops

Returns Edges

`Optional`block

`Optional`_patternRenderer