WebCAD-Lib-TS API 文档 - v1.0.0
    Preparing search index...

    Class SolidEnt

    实体填充类 表示由四个点定义的实体填充区域

    Hierarchy (View Summary)

    Index

    Constructors

    • 构造函数 支持简化的数组写法 [x, y]

      Parameters

      • point1: PointInput = ...

        第一个点,支持 Point2D 或数组 [x, y],默认为原点

      • point2: PointInput = ...

        第二个点,支持 Point2D 或数组 [x, y],默认为原点

      • point3: PointInput = ...

        第三个点,支持 Point2D 或数组 [x, y],默认为原点

      • point4: PointInput = undefined

        第四个点,支持 Point2D 或数组 [x, y],默认为第三个点

      • color: number = 256

        颜色索引,默认为256

      Returns SolidEnt

      // 简化写法 - 三角形
      const solid1 = new SolidEnt([0, 0], [100, 0], [50, 100]);

      // 简化写法 - 四边形
      const solid2 = new SolidEnt([0, 0], [100, 0], [100, 100], [0, 100]);

    Properties

    type: string

    实体类型标识符(如"LINE"、"CIRCLE"等)

    objectId: string

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

    id: number

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

    _lineType: string
    _isAlive: boolean
    isDirty: boolean

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

    block?: any

    Accessors

    • get color(): number

      获取颜色索引

      Returns number

      颜色索引值(256表示"随图层"颜色)

    • set color(value: number): void

      设置颜色索引

      Parameters

      • value: number

        颜色索引值(256表示"随图层"颜色)

      Returns void

    • get layerId(): string

      获取图层ID

      Returns string

      图层ID字符串

    • set layerId(value: string): void

      设置图层ID

      Parameters

      • value: string

        图层ID字符串

      Returns void

    • get lineTypeScale(): number

      获取线型比例

      Returns number

      线型比例因子

    • set lineTypeScale(value: number): void

      设置线型比例

      Parameters

      • value: number

        线型比例因子

      Returns void

    • get lineWeight(): number

      获取线宽

      Returns number

      线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值,单位为0.01mm)

    • set lineWeight(value: number): void

      设置线宽

      Parameters

      • value: number

        线宽值(-1=ByLayer, -2=ByBlock, >=0为具体值)

      Returns void

    • get transpMgr(): TransparencyManager

      获取透明度管理器

      Returns TransparencyManager

      透明度管理器实例

    • set transpMgr(value: TransparencyManager): void

      设置透明度管理器

      Parameters

      Returns void

    • get isAlive(): boolean

      获取实体存活状态

      Returns boolean

      是否存活(true表示有效,false表示已删除)

    • set isAlive(value: boolean): void

      设置实体存活状态

      Parameters

      • value: boolean

        是否存活

      Returns void

    • get xdataRaw(): Record<string, string>

      获取原始扩展数据(用于序列化) 格式: { "1001": "AppName", "1000": "JSON字符串" }

      Returns Record<string, string>

      原始xdata对象或undefined

    • set xdataRaw(value: Record<string, string>): void

      设置原始扩展数据(从数据库加载时使用)

      Parameters

      • value: Record<string, string>

        原始xdata对象

      Returns void

    • get extData(): Record<string, any>

      获取扩展数据(用户友好格式) 自动解析JSON字符串返回对象

      Returns Record<string, any>

      解析后的扩展数据对象,或undefined

      const data = entity.extData;
      console.log(data?.sensorVal); // 10
    • get extDataAppName(): string

      获取扩展数据的应用程序名(AppName)

      Returns string

      AppName字符串,或undefined

    • get doc(): any

      获取所属文档

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

      Returns any

      文档对象,如果无法获取则返回undefined

    • get layer(): string

      获取图层名称

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

      Returns string

      图层名称,默认为"0"

    • set layer(layerName: string): void

      设置图层名称

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

      注意:优先使用实体所属文档的图层列表,如果实体尚未添加到文档, 则使用 Engine.currentDoc 的图层列表。

      Parameters

      • layerName: string

        图层名称

      Returns void

    • get lineType(): string

      获取线型

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

      Returns string

      线型名称

    • set lineType(lineTypeName: string): void

      设置线型

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

      支持的线型:

      • CONTINUOUS: 连续线(实线)
      • HIDDEN/DASHED: 虚线(虚线)
      • CENTER: 中心线
      • PHANTOM: 幻影线
      • DOT: 点线(映射为虚线)
      • 自定义线型:通过LinetypeManager管理的线型

      Parameters

      • lineTypeName: string

        线型名称

      Returns void

    • get point1(): Point2D

      获取第一个点

      Returns Point2D

    • set point1(val: PointInput): void

      设置第一个点并标记修改

      Parameters

      • val: PointInput

        新的坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get point2(): Point2D

      获取第二个点

      Returns Point2D

    • set point2(val: PointInput): void

      设置第二个点并标记修改

      Parameters

      • val: PointInput

        新的坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get point3(): Point2D

      获取第三个点

      Returns Point2D

    • set point3(val: PointInput): void

      设置第三个点并标记修改

      Parameters

      • val: PointInput

        新的坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get point4(): Point2D

      获取第四个点

      Returns Point2D

    • set point4(val: PointInput): void

      设置第四个点并标记修改

      Parameters

      • val: PointInput

        新的坐标,支持 Point2D 或数组 [x, y]

      Returns void

    • get subEnts(): LineEnt[]

      Returns LineEnt[]

    • get subGeometries(): GLine[]

      获取实体填充的轻量级几何体集合(用于几何计算和渲染)

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

      Returns GLine[]

      轻量级几何体数组

    Methods

    • 设置扩展数据(用户友好格式) 自动将对象序列化为JSON字符串存储

      Parameters

      • appName: string

        应用程序名(用于在DWG中标识数据来源)

      • data: Record<string, any>

        要存储的数据对象(将被序列化为JSON)

      Returns void

      entity.setExtData("MY_SENSOR", {
      sensorVal: 10,
      deviceName: "温度传感器",
      isActive: true
      });
    • 清除扩展数据

      Returns void

    • 检查是否有扩展数据

      Returns boolean

      是否存在扩展数据

    • 从默认属性对象复制属性

      将指定的默认属性对象的所有相关属性复制到当前实体。 这通常用于创建新实体时应用默认设置。

      Parameters

      • defaultPropsObject: any

        默认属性对象,包含layer、colorIndex、lineType等属性

      Returns this

      当前实例(支持链式调用)

    • 设置为系统默认值

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

      使用的全局变量:

      • Engine.currentDoc.CLAYER: 当前图层名称
      • Engine.CECOLOR: 当前实体颜色
      • Engine.CELTYPE: 当前实体线型
      • Engine.CELTSCALE: 当前实体线型比例

      Returns void

    • 从数据库默认属性对象设置属性

      从数据库查询结果或序列化数据中恢复实体属性。 这个方法处理数据库中可能存在的空值和默认值情况。

      Parameters

      • dbPropsObject: any

        数据库属性对象,包含layerId、colorIndex等属性

      Returns this

      当前实例(支持链式调用)

    • 将属性映射到数据库默认属性对象

      将当前实体的属性映射到数据库存储格式的对象中。 用于保存实体数据到数据库或序列化。

      Parameters

      • targetDbObject: any

        目标数据库属性对象

      Returns any

      映射后的属性对象

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

      Returns void

    • 获取OpenGL渲染用的点数组

      Returns Point2D[]

      点数组

    • 检查所有点是否在指定框内

      Parameters

      Returns boolean

      是否所有点都在框内

    • 获取所有点

      Returns Point2D[]

      点数组

    • 清除几何缓存

      Returns void

    • 重写 setModified 以清除几何缓存

      Returns void

    • 获取边界实体

      Returns LineEnt[]

      边界线段数组

    • 旋转操作

      Parameters

      • centerPoint: PointInput

        旋转中心

      • angle: number

        旋转角度

      Returns void

    • 缩放操作

      Parameters

      • centerPoint: PointInput

        缩放中心

      • scaleFactor: number

        缩放比例

      Returns void

    • 修复拉伸操作

      Parameters

      • sourceSolid: SolidEnt

        源实体填充对象

      Returns void

    • 夹点编辑

      Parameters

      • newPosition: Point2D

        新位置

      • gripName: string

        夹点名称

      Returns void

    • 中点夹点编辑

      Parameters

      • newPosition: Point2D

        新位置

      • edgeIndex: string

        边索引

      Returns void

    • 撤销映射

      Parameters

      • undoData: SolidEnt

        源实体填充对象

      Returns void

    • 克隆对象

      Returns SolidEnt

      克隆的实体填充对象

    • 转换为数据库对象

      Returns DbSolid

      数据库实体填充对象

    • 从数据库对象加载

      Parameters

      • dbData: DbSolid

        数据库实体填充对象

      Returns void