Class BlockDefinition

块定义类表示CAD中的块定义，包含块的所有实体和属性块是可重复使用的图形元素集合

Example

import { BlockDefinition, LineEnt, Point2D, Engine } from '@aspect/webcad-lib-ts';

// 获取块定义
const block = Engine.currentDoc.blocks.itemByName("我的块");

// 遍历块中的实体
for (const entity of block.items) {
  console.log(entity.type);
}

Constructors

constructor

new BlockDefinition(document: any): BlockDefinition
构造函数
Parameters
- document: any
  文档对象
Returns BlockDefinition
- Defined in entities/BlockDefinition.ts:136

Properties

blockId

blockId: string

块ID（8位GUID字符串，空字符串表示未分配）

isLayout

isLayout: boolean

是否为布局块

isXref

isXref: boolean

是否为外部引用

name

name: string

块名称

lookPt

lookPt: Point2D

视点坐标

twistAngle

twistAngle: number

扭转角度

zoom

zoom: number

缩放比例

UCSXANG

UCSXANG: number

用户坐标系X轴角度

UCSORG

UCSORG: Point2D

用户坐标系原点

items

items: any[]

块中的实体数组

doc

doc: CadDocument

所属文档

initBounds

initBounds: number[]

初始范围 [minX, minY, maxX, maxY]（WCS坐标）用于 zoom=0 时前端自动缩放到初始范围

lazyEntities

lazyEntities: Map<string, { entity: any; originalIndex: number }[]>

readOnlyGraphics

readOnlyGraphics: CadGraphics = null

只读层的 Graphics 引用

Accessors

basePoint

get basePoint(): Point2D
获取块基点

Returns Point2D
- Defined in entities/BlockDefinition.ts:162
set basePoint(value: Point2D | [number, number]): void
设置块基点，支持 Point2D 或 [x, y] 数组形式
Parameters
- value: Point2D | [number, number]
Returns void
- Defined in entities/BlockDefinition.ts:170

count

get count(): number
Returns number
- Defined in entities/BlockDefinition.ts:229

aliveItems

get aliveItems(): any[]
Returns any[]
- Defined in entities/BlockDefinition.ts:233

Methods

setDoc

setDoc(document: any): void
Parameters
- document: any
Returns void
- Defined in entities/BlockDefinition.ts:178

setZoom

setZoom(zoomValue: number): void
Parameters
- zoomValue: number
Returns void
- Defined in entities/BlockDefinition.ts:182

zoomIn

zoomIn(zoomFactor?: number): void
Parameters
- zoomFactor: number = 0.9
Returns void
- Defined in entities/BlockDefinition.ts:199

zoomOut

zoomOut(zoomFactor?: number): void
Parameters
- zoomFactor: number = 0.9
Returns void
- Defined in entities/BlockDefinition.ts:214

isPurgerable

isPurgerable(): boolean
Returns boolean
- Defined in entities/BlockDefinition.ts:237

pushEntity

pushEntity(entity: EntityBase): EntityBase
Parameters
- entity: EntityBase
Returns EntityBase
- Defined in entities/BlockDefinition.ts:253

add

add(entity: EntityBase): EntityBase
Parameters
- entity: EntityBase
Returns EntityBase
- Defined in entities/BlockDefinition.ts:305

addEntity

addEntity(entity: EntityBase): EntityBase
添加实体到块定义（add的别名，使API更清晰）
Parameters
- entity: EntityBase
  要添加的实体
Returns EntityBase
添加的实体或null（如果被事件取消）
- Defined in entities/BlockDefinition.ts:315

addEntities

addEntities(entities: EntityBase[]): EntityBase[]
Parameters
- entities: EntityBase[]
Returns EntityBase[]
- Defined in entities/BlockDefinition.ts:319

eraseEntities

eraseEntities(entities: EntityBase[]): EntityBase[]
Parameters
- entities: EntityBase[]
Returns EntityBase[]
- Defined in entities/BlockDefinition.ts:370

erase

erase(entities: EntityBase[]): EntityBase[]
Parameters
- entities: EntityBase[]
Returns EntityBase[]
- Defined in entities/BlockDefinition.ts:430

getViewCenterWcs

getViewCenterWcs(): Point2D
获取视图中心的WCS坐标用于计算渲染原点是否需要更新

Returns Point2D
视图中心的WCS坐标
- Defined in entities/BlockDefinition.ts:439

needsRebase

needsRebase(centerWcs: Point2D, threshold?: number): boolean
判断是否需要重新设置渲染原点
Parameters
- centerWcs: Point2D
  当前视图中心的WCS坐标
- threshold: number = 50000
  触发Rebase的阈值，默认50000
Returns boolean
是否需要Rebase
- Defined in entities/BlockDefinition.ts:451

rebaseTo

rebaseTo(centerWcs: Point2D, step?: number): boolean
重新设置渲染原点
Parameters
- centerWcs: Point2D
  新的中心WCS坐标
- step: number = 10000
  吸附步长，默认10000，减少频繁Rebase
Returns boolean
渲染原点是否发生了变化
- Defined in entities/BlockDefinition.ts:464

getLocalRenderShift

getLocalRenderShift(): Point2D
获取图元局部坐标系的渲染偏移用于设置CadGraphics的position，将大坐标变为小坐标

Returns Point2D
局部渲染偏移 (-renderOrigin.x, +renderOrigin.y)
- Defined in entities/BlockDefinition.ts:483

getContainerRebaseDelta

getContainerRebaseDelta(): Point2D
获取容器的补偿位移用于在容器层级补偿局部坐标系的偏移，保持视觉效果不变

Returns Point2D
容器补偿位移
- Defined in entities/BlockDefinition.ts:493

enableRenderOrigin

enableRenderOrigin(centerWcs?: Point2D, step?: number): boolean
启用渲染原点功能根据当前视图中心自动设置渲染原点，解决大坐标精度问题
Parameters
- centerWcs: Point2D = null
  可选的中心点，默认使用当前视图中心
- step: number = 10000
  吸附步长，默认10000
Returns boolean
是否成功启用
- Defined in entities/BlockDefinition.ts:508

disableRenderOrigin

disableRenderOrigin(): void
禁用渲染原点功能将渲染原点设置为null，恢复传统渲染方式

Returns void
- Defined in entities/BlockDefinition.ts:527

isRenderOriginEnabled

isRenderOriginEnabled(): boolean
检查渲染原点是否已启用

Returns boolean
是否已启用渲染原点
- Defined in entities/BlockDefinition.ts:535

forceEnableRenderOrigin

forceEnableRenderOrigin(centerWcs?: Point2D): void
强制启用渲染原点并触发重绘用于解决大坐标精度问题的快速修复方法
Parameters
- centerWcs: Point2D = null
  可选的中心点，默认使用当前视图中心
Returns void
- Defined in entities/BlockDefinition.ts:544

removeEnts

removeEnts(entitiesToRemove: EntityBase[]): void
Parameters
- entitiesToRemove: EntityBase[]
Returns void
- Defined in entities/BlockDefinition.ts:562

map

map(sourceBlock: BlockDefinition): void
Parameters
- sourceBlock: BlockDefinition
Returns void
- Defined in entities/BlockDefinition.ts:568

clone

clone(): BlockDefinition
Returns BlockDefinition
- Defined in entities/BlockDefinition.ts:582

toDb

toDb(): DbBlock
Returns DbBlock
- Defined in entities/BlockDefinition.ts:610

fromDb

fromDb(dbData: any): void
Parameters
- dbData: any
Returns void
- Defined in entities/BlockDefinition.ts:642

loadLazyEntitiesForLayer

loadLazyEntitiesForLayer(layerId: string): Promise<void>
加载指定图层的延迟实体当图层第一次被打开时，从延迟加载的数据中创建实体对象根据原始索引将实体插入到正确位置以保持绘制次序
Parameters
- layerId: string
  图层ID（字符串类型）
Returns Promise<void>
加载的实体数量
- Defined in entities/BlockDefinition.ts:689

handleLayerDeleted

handleLayerDeleted(deletedLayerId: string): void
处理图层删除时的lazyEntities清理直接删除该图层的延迟加载实体数据
Parameters
- deletedLayerId: string
  被删除的图层ID（字符串类型）
Returns void
- Defined in entities/BlockDefinition.ts:832

handleLayerIdRenumbered

handleLayerIdRenumbered(idMapping: Map<string, string>): void
处理图层ID重新映射时的lazyEntities更新注意：layerId 现在使用 GUID 字符串，通常不需要重新编号此方法保留用于特殊情况下的图层ID迁移
Parameters
- idMapping: Map<string, string>
  图层ID映射表，格式：Map<oldId, newId>
Returns void
- Defined in entities/BlockDefinition.ts:847

loadReadOnlyEntities

loadReadOnlyEntities(
    dbEntities: any[],
    renderer: EntityRenderer,
    graphics: CadGraphics,
): void
加载只读实体并渲染到底图层渲染完成后释放临时实体对象以节省内存
Parameters
- dbEntities: any[]
  只读实体的数据库数据数组
- renderer: EntityRenderer
  实体渲染器
- graphics: CadGraphics
  目标 Graphics 对象（只读层）
Returns void
- Defined in entities/BlockDefinition.ts:884

clearReadOnlyLayer

clearReadOnlyLayer(): void
清除只读层

Returns void
- Defined in entities/BlockDefinition.ts:977

setReadOnlyAlpha

setReadOnlyAlpha(alpha: number): void
设置只读层透明度
Parameters
- alpha: number
  透明度值 (0-1)
Returns void
- Defined in entities/BlockDefinition.ts:989

dispose

dispose(): void
释放块内资源，避免引用悬挂

Returns void
- Defined in entities/BlockDefinition.ts:998

Class BlockDefinition

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BlockDefinition

Properties

blockId

isLayout

isXref

name

lookPt

twistAngle

zoom

UCSXANG

UCSORG

items

doc

initBounds

lazyEntities

readOnlyGraphics

Accessors

basePoint

Returns Point2D

Parameters

Returns void

count

Returns number

aliveItems

Returns any[]

Methods

setDoc

Parameters

Returns void

setZoom

Parameters

Returns void

zoomIn

Parameters

Returns void

zoomOut

Parameters

Returns void

isPurgerable

Returns boolean

pushEntity

Parameters

Returns EntityBase

add

Parameters

Returns EntityBase

addEntity

Parameters

Returns EntityBase

addEntities

Parameters

Returns EntityBase[]

eraseEntities

Parameters

Returns EntityBase[]

erase

Parameters

Returns EntityBase[]

getViewCenterWcs

Returns Point2D

needsRebase

Parameters

Returns boolean

rebaseTo

Parameters

Returns boolean

getLocalRenderShift

Returns Point2D

getContainerRebaseDelta

Returns Point2D