Class ImageRefEnt

constructor

• new ImageRefEnt(
      insertionPoint?: PointInput,
      rotation?: number,
      scaleFactor?: number,
  ): ImageRefEnt

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

  Parameters

  • insertionPoint: PointInput = ...

    插入点，支持 Point2D 或数组 [x, y]，默认为原点

  • rotation: number = 0

    旋转角度，默认0

  • scaleFactor: number = 1

    缩放因子，默认1

  Returns ImageRefEnt

  Example

  // 简化写法
  const image1 = new ImageRefEnt([100, 100], 0, 1);
  
  // Point2D 写法
  const image2 = new ImageRefEnt(new Point2D(100, 100), 0, 1);
  Copy

type

objectId

id

_lineType

_isAlive

isDirty

Optionalblock

name

imageId

base64

ftype

_clipMinX

_clipMinY

_clipMaxX

_clipMaxY

OptionalbaseTexture

color

• get color(): number

  获取颜色索引

  Returns number

  颜色索引值（256表示"随图层"颜色）

• set color(value: number): void

  设置颜色索引

  Parameters

  • value: number

    颜色索引值（256表示"随图层"颜色）

  Returns void

layerId

• get layerId(): string

  获取图层ID

  Returns string

  图层ID字符串

• set layerId(value: string): void

  设置图层ID

  Parameters

  • value: string

    图层ID字符串

  Returns void

lineTypeScale

• get lineTypeScale(): number

  获取线型比例

  Returns number

  线型比例因子

• set lineTypeScale(value: number): void

  设置线型比例

  Parameters

  • value: number

    线型比例因子

  Returns void

lineWeight

• 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

transpMgr

• get transpMgr(): TransparencyManager

  获取透明度管理器

  Returns TransparencyManager

  透明度管理器实例

• set transpMgr(value: TransparencyManager): void

  设置透明度管理器

  Parameters

  • value: TransparencyManager

    透明度管理器实例

  Returns void

isAlive

• get isAlive(): boolean

  获取实体存活状态

  Returns boolean

  是否存活（true表示有效，false表示已删除）

• set isAlive(value: boolean): void

  设置实体存活状态

  Parameters

  • value: boolean

    是否存活

  Returns void

xdataRaw

• 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

extData

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

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

  Returns Record<string, any>

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

  Example

  const data = entity.extData;
  console.log(data?.sensorVal); // 10
  Copy

extDataAppName

• get extDataAppName(): string

  获取扩展数据的应用程序名（AppName）

  Returns string

  AppName字符串，或undefined

doc

• get doc(): any

  获取所属文档

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

  Returns any

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

layer

• get layer(): string

  获取图层名称

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

  Returns string

  图层名称，默认为"0"

• set layer(layerName: string): void

  设置图层名称

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

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

  Parameters

  • layerName: string

    图层名称

  Returns void

lineType

• get lineType(): string

  获取线型

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

  Returns string

  线型名称

• set lineType(lineTypeName: string): void

  设置线型

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

  支持的线型：

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

  Parameters

  • lineTypeName: string

    线型名称

  Returns void

insertionPoint

• get insertionPoint(): Point2D

  Returns Point2D

• set insertionPoint(value: PointInput): void

  Parameters

  • value: PointInput

  Returns void

width

• get width(): number

  Returns number

• set width(value: number): void

  Parameters

  • value: number

  Returns void

height

• get height(): number

  Returns number

• set height(value: number): void

  Parameters

  • value: number

  Returns void

scaleFactor

• get scaleFactor(): number

  Returns number

• set scaleFactor(value: number): void

  Parameters

  • value: number

  Returns void

rotation

• get rotation(): number

  Returns number

• set rotation(value: number): void

  Parameters

  • value: number

  Returns void

url

• get url(): string

  Returns string

• set url(value: string): void

  Parameters

  • value: string

  Returns void

imageAlpha

• get imageAlpha(): number

  Returns number

• set imageAlpha(value: number): void

  Parameters

  • value: number

  Returns void

clipMode

• get clipMode(): number

  Returns number

• set clipMode(value: number): void

  Parameters

  • value: number

  Returns void

reverseClip

• get reverseClip(): boolean

  Returns boolean

• set reverseClip(value: boolean): void

  Parameters

  • value: boolean

  Returns void

clipMinPosition

• get clipMinPosition(): Point2D

  获取裁剪最小位置

  Returns Point2D

  最小位置点

clipMaxPosition

• get clipMaxPosition(): Point2D

  获取裁剪最大位置

  Returns Point2D

  最大位置点

clipMinX

• get clipMinX(): number

  获取裁剪最小X坐标

  Returns number

  最小X坐标

clipMinY

• get clipMinY(): number

  获取裁剪最小Y坐标

  Returns number

  最小Y坐标

clipMaxX

• get clipMaxX(): number

  获取裁剪最大X坐标

  Returns number

  最大X坐标

clipMaxY

• get clipMaxY(): number

  获取裁剪最大Y坐标

  Returns number

  最大Y坐标

clipLeft

• get clipLeft(): number

  获取裁剪左边距

  Returns number

  左边距

clipBottom

• get clipBottom(): number

  获取裁剪底边距

  Returns number

  底边距

clipRight

• get clipRight(): number

  获取裁剪右边距

  Returns number

  右边距

clipTop

• get clipTop(): number

  获取裁剪顶边距

  Returns number

  顶边距

scaledWidth

• get scaledWidth(): number

  获取缩放后的宽度

  Returns number

  缩放后宽度

scaledHeight

• get scaledHeight(): number

  获取缩放后的高度

  Returns number

  缩放后高度

dpi

• get dpi(): number

  获取DPI（每英寸点数）

  Returns number

  DPI值

dpm

• get dpm(): number

  获取DPM（每毫米点数）

  Returns number

  DPM值

point1

• get point1(): Point2D

  获取第1个角点（左下角）

  Returns Point2D

  点对象

point2

• get point2(): Point2D

  获取第2个角点（右下角）

  Returns Point2D

  点对象

point3

• get point3(): Point2D

  获取第3个角点（右上角）

  Returns Point2D

  点对象

point4

• get point4(): Point2D

  获取第4个角点（左上角）

  Returns Point2D

  点对象

clipPt1

• get clipPt1(): Point2D

  获取裁剪区域第1个角点（左下角）

  Returns Point2D

  点对象

clipPt2

• get clipPt2(): Point2D

  获取裁剪区域第2个角点（右下角）

  Returns Point2D

  点对象

clipPt3

• get clipPt3(): Point2D

  获取裁剪区域第3个角点（右上角）

  Returns Point2D

  点对象

clipPt4

• get clipPt4(): Point2D

  获取裁剪区域第4个角点（左上角）

  Returns Point2D

  点对象

TL

• get TL(): Point2D

  获取顶部左侧点（TL = Top Left）

  Returns Point2D

  点对象

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
  });
  Copy

clearExtData

• clearExtData(): void

  清除扩展数据

  Returns void

hasExtData

• hasExtData(): boolean

  检查是否有扩展数据

  Returns boolean

  是否存在扩展数据

fromDefaultProps

• fromDefaultProps(defaultPropsObject: any): this

  从默认属性对象复制属性

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

  Parameters

  • defaultPropsObject: any

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

  Returns this

  当前实例（支持链式调用）

setDefaults

• setDefaults(): void

  设置为系统默认值

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

  使用的全局变量：

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

  Returns void

fromDbDefaultProps

• fromDbDefaultProps(dbPropsObject: any): this

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

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

  Parameters

  • dbPropsObject: any

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

  Returns this

  当前实例（支持链式调用）

mapToDbDefaultProps

• mapToDbDefaultProps(targetDbObject: any): any

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

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

  Parameters

  • targetDbObject: any

    目标数据库属性对象

  Returns any

  映射后的属性对象

setModified

• setModified(): void

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

  Returns void

dispose

• dispose(): void

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

  Returns void

getClipModeKw

• getClipModeKw(): string

  获取裁剪模式关键字

  Returns string

  裁剪模式字符串

setImageSource

• setImageSource(imageSource: ImageSource): void

  设置图像源

  Parameters

  • imageSource: ImageSource

    图像源对象

  Returns void

resetClip

• resetClip(): void

  重置裁剪区域

  Returns void

setClipMinX

• setClipMinX(xValue: number): void

  设置裁剪最小X坐标

  Parameters

  • xValue: number

    X坐标值

  Returns void

setClipMinY

• setClipMinY(yValue: number): void

  设置裁剪最小Y坐标

  Parameters

  • yValue: number

    Y坐标值

  Returns void

setClipMaxX

• setClipMaxX(xValue: number): void

  设置裁剪最大X坐标

  Parameters

  • xValue: number

    X坐标值

  Returns void

setClipMaxY

• setClipMaxY(yValue: number): void

  设置裁剪最大Y坐标

  Parameters

  • yValue: number

    Y坐标值

  Returns void

getTextureMatrix

• getTextureMatrix(): Matrix

  获取纹理变换矩阵

  Returns Matrix

  变换矩阵

getBoundingBox

• getBoundingBox(): BoundingBox

  获取边界框

  Returns BoundingBox

  边界框对象

getClipBox

• getClipBox(): BoundingBox

  获取裁剪框（带边距）

  Returns BoundingBox

  裁剪框对象

getIntersectBox

• getIntersectBox(targetBox: BoundingBox): BoundingBox

  获取与指定框的交集框

  Parameters

  • targetBox: BoundingBox

    目标边界框

  Returns BoundingBox

  交集边界框

allPointsWithInBox

• allPointsWithInBox(boundingBox: BoundingBox): boolean

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

  Parameters

  • boundingBox: BoundingBox

    边界框

  Returns boolean

  是否在框内

mirror

• mirror(mirrorAxisStart: PointInput, mirrorAxisEnd: PointInput): void

  镜像变换

  Parameters

  • mirrorAxisStart: PointInput

    镜像轴起点

  • mirrorAxisEnd: PointInput

    镜像轴终点

  Returns void

move

• move(fromPoint: PointInput, toPoint: PointInput): void

  移动变换

  Parameters

  • fromPoint: PointInput

    起始点

  • toPoint: PointInput

    目标点

  Returns void

rotate

• rotate(centerPoint: PointInput, rotationAngle: number): void

  旋转变换

  Parameters

  • centerPoint: PointInput

    旋转中心点

  • rotationAngle: number

    旋转角度

  Returns void

stretch

• stretch(
      fromPoint: PointInput,
      toPoint: PointInput,
      stretchBox: BoundingBox,
  ): void

  拉伸变换 根据拉伸区域和模式（普通或裁剪）进行相应的拉伸操作

  Parameters

  • fromPoint: PointInput

    起始点

  • toPoint: PointInput

    目标点

  • stretchBox: BoundingBox

    拉伸区域对象

  Returns void

repairStretch

• repairStretch(
      fromPoint: Point2D,
      toPoint: Point2D,
      stretchBox: BoundingBox,
  ): void

  修复拉伸操作 用于修正拉伸后可能出现的问题

  Parameters

  • fromPoint: Point2D

    起始点

  • toPoint: Point2D

    目标点

  • stretchBox: BoundingBox

    拉伸区域对象

  Returns void

scale

• scale(basePoint: PointInput, scaleFactor: number): void

  缩放变换 以指定点为基准进行缩放

  Parameters

  • basePoint: PointInput

    缩放基准点

  • scaleFactor: number

    缩放因子

  Returns void

gripEdit_Scale1

• gripEdit_Scale1(newPoint: Point2D): void

  夹点编辑 - 缩放点1（左下角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Scale2

• gripEdit_Scale2(newPoint: Point2D): void

  夹点编辑 - 缩放点2（右下角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Scale3

• gripEdit_Scale3(newPoint: Point2D): void

  夹点编辑 - 缩放点3（右上角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Scale4

• gripEdit_Scale4(newPoint: Point2D): void

  夹点编辑 - 缩放点4（左上角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Clip1

• gripEdit_Clip1(newPoint: Point2D): void

  夹点编辑 - 裁剪点1（左下角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Clip2

• gripEdit_Clip2(newPoint: Point2D): void

  夹点编辑 - 裁剪点2（右下角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Clip3

• gripEdit_Clip3(newPoint: Point2D): void

  夹点编辑 - 裁剪点3（右上角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit_Clip4

• gripEdit_Clip4(newPoint: Point2D): void

  夹点编辑 - 裁剪点4（左上角）

  Parameters

  • newPoint: Point2D

    新的点位置

  Returns void

gripEdit

• gripEdit(newPoint: Point2D, gripType: string): void

  夹点编辑主方法 根据夹点标识执行相应的编辑操作

  Parameters

  • newPoint: Point2D

    点位置

  • gripType: string

    夹点标识（"1"-"4"为缩放点，"c1"-"c4"为裁剪点）

  Returns void

getSubEnts

• getSubEnts(): any[]

  获取实体列表

  Returns any[]

  空数组（图像引用不包含子实体）

boundingBox

• boundingBox(coordinateSystemType?: number): BoundingBox

  获取边界框 根据坐标系类型和裁剪模式返回相应的边界框

  Parameters

  • coordinateSystemType: number = CoordinateSystemType.WCS

    坐标系类型，默认WCS

  Returns BoundingBox

  边界框对象

undoMap

• undoMap(undoData: ImageRefEnt): void

  撤销映射，恢复对象状态

  Parameters

  • undoData: ImageRefEnt

    原始状态对象

  Returns void

clone

• clone(): ImageRefEnt

  克隆对象

  Returns ImageRefEnt

  克隆的图像引用对象

toDb

• toDb(): DbImageRef

  转换为数据库对象

  Returns DbImageRef

  数据库对象

fromDb

• fromDb(dbData: DbImageRef): void

  从数据库对象恢复

  Parameters

  • dbData: DbImageRef

    数据库对象

  Returns void