mxcad_2d API 文档 / 2d / McDbRasterImageDef

Class: McDbRasterImageDef

2d.McDbRasterImageDef

McDbRasterImageDef 是光栅图像定义对象，用于描述 CAD 中的图片资源定义和图像文件路径。

Description

该类用于管理光栅图像的来源文件、图像数据以及图像存储方式。 通过它可以完成：

• 绑定和读取光栅图像文件路径；
• 保存图像为 Base64 数据；
• 作为图像定义对象提供给 CAD 的图像实体使用。

使用方式：

1. 创建 McDbRasterImageDef 实例；
2. 设置 sourceFileName；
3. 通过 saveToBase64() 生成可传输的图片数据；
4. 进一步用于图像实体显示和图纸集成。

总结：在实际开发中，McDbRasterImageDef 是光栅图像资源的定义层，适用于嵌入、显示和传输图像数据。

Example

import { McDbRasterImageDef } from "mxcad";

// 创建并配置栅格图像定义对象。
async function testRasterImageDef() {
  const imageDef = new McDbRasterImageDef();
  imageDef.sourceFileName = "https://cdn.pixabay.com/photo/2022/11/15/12/23/winter-7593872_960_720.jpg";
  const base64 = imageDef.saveToBase64(imageDef.sourceFileName);
  console.log("保存 Base64 成功:", base64);
}

Hierarchy

• McDbObject

  ↳ McDbRasterImageDef

Table of contents

Constructors

• constructor

Properties

• imp

Accessors

• dxf0
• objectName
• sourceFileName

Methods

• assertObjectModification
• clone
• createExtensionDictionary
• erase
• getDatabase
• getDatabaseIndexId
• getExtensionDictionary
• getGripEditBasePointsIndex
• getGripPoints
• getHandle
• getImp
• getJson
• getObjectID
• getOwnerID
• initTempObject
• isErased
• isHaveExtensionDictionary
• isKindOf
• isNull
• moveGripPointsAt
• saveToBase64
• setJson
• unErase

Constructors

constructor

• new McDbRasterImageDef(imp?)

构造函数。

Parameters

Name	Type	Description
imp?	any	内部实现对象。

Overrides

McDbObject.constructor

Properties

imp

• imp: any = 0

内部实现对象。

Inherited from

McDbObject.imp

Accessors

dxf0

• get dxf0(): string

得到对象的DXF组码的类型名，这个和AutoCAD中的DXF组码是一样。 比如直线的类型名为：McDbLine，DXF0组码值: LINE,DXF0组码值可以用来构造集时的类型过滤。

Returns

string

Inherited from

McDbObject.dxf0

---

objectName

• get objectName(): string

获取对象名称。

Returns

string

返回对象名

Inherited from

McDbObject.objectName

---

sourceFileName

• get sourceFileName(): string

Returns

string

• set sourceFileName(sPathName): void

获取或设置栅格图像文件的路径。

Parameters

Name	Type	Description
sPathName	string	文件的路径

Returns

void

Methods

assertObjectModification

▸ assertObjectModification(autoUndo?): number

设置对象被改变的状态，可自动触发更新显示函数，更新显示。 比如块表记录更新了，需要通知块引用更新显示，可以调用该函数。

Parameters

Name	Type	Default value	Description
autoUndo	boolean	false	这次修改是否要自动支持撤销,默认为false

Returns

number

Inherited from

McDbObject.assertObjectModification

---

clone

▸ clone(): null | McDbObject

克隆对象。

Returns

null | McDbObject

克隆出的对象。

Inherited from

McDbObject.clone

---

createExtensionDictionary

▸ createExtensionDictionary(): boolean

创建对象的扩展字典数据.

Returns

boolean

Inherited from

McDbObject.createExtensionDictionary

---

erase

▸ erase(): boolean

删除对象。

Returns

boolean

是否删除成功。

Inherited from

McDbObject.erase

---

getDatabase

▸ getDatabase(): McDbDatabase

得到对象所在的数据库

Returns

McDbDatabase

返回数据库

Inherited from

McDbObject.getDatabase

---

getDatabaseIndexId

▸ getDatabaseIndexId(): number

获取对象的索引ID

Returns

number

Inherited from

McDbObject.getDatabaseIndexId

---

getExtensionDictionary

▸ getExtensionDictionary(): McDbDictionary

得到对象的扩展字典数据.

Returns

McDbDictionary

扩展字典数据

Inherited from

McDbObject.getExtensionDictionary

---

getGripEditBasePointsIndex

▸ getGripEditBasePointsIndex(): number[]

获取对象的夹点对应的编辑基点索引。

Returns

number[]

Inherited from

McDbObject.getGripEditBasePointsIndex

---

getGripPoints

▸ getGripPoints(): McGePoint3dArray

获取对象的夹点数组

Returns

McGePoint3dArray

Inherited from

McDbObject.getGripPoints

---

getHandle

▸ getHandle(): string

得到对象句柄

Returns

string

返回对象句柄

Inherited from

McDbObject.getHandle

---

getImp

▸ getImp(): any

获取内部实现对象。

Returns

any

内部实现对象。

Inherited from

McDbObject.getImp

---

getJson

▸ getJson(): string

获取 JSON 格式的字符串。

Returns

string

JSON 格式的字符串。

Inherited from

McDbObject.getJson

---

getObjectID

▸ getObjectID(): McObjectId

获取对象 ID。

Returns

McObjectId

对象 ID。

Inherited from

McDbObject.getObjectID

---

getOwnerID

▸ getOwnerID(): number

得到对象拥用者的id

Returns

number

Inherited from

McDbObject.getOwnerID

---

initTempObject

▸ initTempObject(imp): void

初始化临时对象。

Parameters

Name	Type	Description
imp	any	内部实现对象。

Returns

void

Inherited from

McDbObject.initTempObject

---

isErased

▸ isErased(): boolean

对象是否已经删除

Returns

boolean

Inherited from

McDbObject.isErased

---

isHaveExtensionDictionary

▸ isHaveExtensionDictionary(): boolean

是否有扩展字典数据.

Returns

boolean

Inherited from

McDbObject.isHaveExtensionDictionary

---

isKindOf

▸ isKindOf(sObjectName): boolean

判断对象类型

Parameters

Name	Type	Description
sObjectName	string	类型名

Returns

boolean

返回对象是否是目标类型

Inherited from

McDbObject.isKindOf

---

isNull

▸ isNull(): any

判断是否为空对象

Returns

any

Inherited from

McDbObject.isNull

---

moveGripPointsAt

▸ moveGripPointsAt(iIndex, dXOffset, dYOffset, dZOffset): any

移动对象的夹点

Parameters

Name	Type	Description
iIndex	number	索引
dXOffset	number	X轴偏移量
dYOffset	number	Y轴偏移量
dZOffset	number	Z轴偏移量

Returns

any

Inherited from

McDbObject.moveGripPointsAt

---

saveToBase64

▸ saveToBase64(sUrl): boolean

将栅格图像保存为 Base64 编码的字符串

Parameters

Name	Type	Description
sUrl	string	格栅图像路径

Returns

boolean

布尔值

---

setJson

▸ setJson(str): boolean

设置 JSON 格式的字符串。

Parameters

Name	Type	Description
str	string	JSON 格式的字符串。

Returns

boolean

是否设置成功。

Inherited from

McDbObject.setJson

---

unErase

▸ unErase(): boolean

反删除对象。

Returns

boolean

Inherited from

McDbObject.unErase