mxcad_2d API 文档 / 2d / McAppType
Class: McAppType
2d.McAppType
McAppType 类,提供了 MxCAD 的一些基本操作。
Example
import { MxCpp } from "mxcad";
const McAppType = MxCpp.App;
Table of contents
Constructors
Methods
- IniSet
- addNetworkLoadingBigFont
- addNetworkLoadingFont
- addNetworkLoadingTrueTypeFont
- createCloneObject
- destroyObject
- getCurrentMxCAD
- getImp
- getLastCallResult
- getShxBigFonts
- getShxFonts
- getTrueTypeFonts
- getVersionString
- init
- loadFonts
- mcedRGB2Index
- objectIdIsKindOf
- objectIdToObject
- setDefaultTrueTypeFontFile
- setDefaultViewBackgroundColor
- setFontFilePath
Constructors
constructor
• new McAppType()
Methods
IniSet
▸ IniSet(ini
): boolean
全局参数的初始设置
Example
Parameters
Name | Type | Description |
---|---|---|
ini | object | 初始设置值 |
Returns
boolean
addNetworkLoadingBigFont
▸ addNetworkLoadingBigFont(fontfiles
, fontFilesLoadOnInitialization?
): void
配置需要通过网络加载的bigfont shx字体
Example
import { MxCpp } from 'mxcad'
import { MxFun } from "mxdraw";
// MxCAD创建成功
MxFun.on("mxcadApplicationCreatedMxCADObject", () => {
MxCpp.App.addNetworkLoadingBigFont(["hztxt.shx", "gbcbig.shx"]);
}
Parameters
Name | Type | Default value | Description |
---|---|---|---|
fontfiles | string | string [] | undefined | 加载的字体文件 |
fontFilesLoadOnInitialization | string [] | [] | - |
Returns
void
addNetworkLoadingFont
▸ addNetworkLoadingFont(fontfiles
, fontFilesLoadOnInitialization?
): void
配置需要通过网络加载的shx字体
Example
import { MxCpp } from 'mxcad';
import { MxFun } from "mxdraw";
// MxCAD创建成功
MxFun.on("mxcadApplicationCreatedMxCADObject", () => {
MxCpp.App.addNetworkLoadingFont( ["txt.shx","simplex.shx","aaa.shx","ltypeshp.shx","complex.shx"]);
}
Parameters
Name | Type | Default value | Description |
---|---|---|---|
fontfiles | string | string [] | undefined | 加载的字体文件 |
fontFilesLoadOnInitialization | string [] | [] | - |
Returns
void
addNetworkLoadingTrueTypeFont
▸ addNetworkLoadingTrueTypeFont(fontname
, fontzhName
, fontfile
, fontNamesLoadOnInitialization?
): void
配置需要通过网络加载的Truetype字体
Example
import { MxCpp } from 'mxcad'
import { MxFun } from "mxdraw";
// MxCAD创建成功
MxFun.on("mxcadApplicationCreatedMxCADObject", () => {
MxCpp.App.addNetworkLoadingTrueTypeFont(["simsun","syadobe"],["思原宋体","思原黑体"],["stadobe.otf","syadobe.otf"]);
}
Parameters
Name | Type | Default value | Description |
---|---|---|---|
fontname | string [] | undefined | 字体名 |
fontzhName | string [] | undefined | 字体中文名 |
fontfile | string [] | undefined | 加载字体文件 |
fontNamesLoadOnInitialization | string [] | [] | - |
Returns
void
createCloneObject
▸ createCloneObject(clonobjImp
): null
| McDbObject
创建克隆对象。
Example
import { MxCADUiPrEntity, MxCpp } from "mxcad";
// 获取目标对象
let selEntity = new MxCADUiPrEntity();
let val = await selEntity.go();
if (!val.isValid()) return;
const obj = MxCpp.App.objectIdToObject(val.id);// 对象id转 McDbObject 对象
const obj_clone = MxCpp.App.createCloneObject(obj?.getImp());// 克隆目标对象
Parameters
Name | Type | Description |
---|---|---|
clonobjImp | any | 被克隆的对象。 |
Returns
null
| McDbObject
返回创建的 McDbObject 对象。
destroyObject
▸ destroyObject(pObject
): void
销毁对象。
Parameters
Name | Type | Description |
---|---|---|
pObject | McRxObjectImp | 要销毁的对象。 |
Returns
void
getCurrentMxCAD
▸ getCurrentMxCAD(): McObject
获取当前的 MxDraw 对象。
Example
//添加图层
import { MxCpp } from 'mxcad'
// 获取当前cad对象
let mxcad = MxCpp.App.getCurrentMxCAD();
// 获取图层表
let layerTable = mxcad.getDatabase().getLayerTable();
if (!layerTable.has("xxx11")) {
let newLayer = new McDbLayerTableRecord();// 构造新图层记录对象
newLayer.name = "xxx11";// 设置新图层名为:"xxx11"
layerTable.add(newLayer);// 图层表新增图层记录对象
}
if (layerTable.has("xxx11")) {
console.log("add layer ok");
}
Returns
返回当前的 McObject 对象。
getImp
▸ getImp(): any
获取 imp 对象。
Example
import { MxCpp } from "mxcad";
const imp = MxCpp.App.getImp()
Returns
any
返回 imp 对象。
getLastCallResult
▸ getLastCallResult(): number
获取最后一次调用的结果。
Example
import { MxCpp } from "mxcad";
const result = MxCpp.App.getLastCallResult();
console.log("最后一次调用结果:", result);
Returns
number
返回最后一次调用的结果
getShxBigFonts
▸ getShxBigFonts(): string
[]
得到当前支持的所有bigfont shx字体.
Example
import { MxCpp } from "mxcad";
const bigFontArr = MxCpp.App.getShxBigFonts();
console.log(bigFontArr);
Returns
string
[]
字体数组
getShxFonts
▸ getShxFonts(): string
[]
得到当前支持的所有shx字体.
Example
import { MxCpp } from "mxcad";
const fontArr = MxCpp.App.getShxFonts();
console.log(fontArr);
Returns
string
[]
字体数组
getTrueTypeFonts
▸ getTrueTypeFonts(): { file
: string
; name
: string
; zhname
: string
}[]
得到当前支持的所有TrueType字体.
Example
import { MxCpp } from "mxcad";
const trueTypeFontArr = MxCpp.App.getTrueTypeFonts();
console.log(trueTypeFontAr);
Returns
{ file
: string
; name
: string
; zhname
: string
}[]
name 字体名| zhname 字体中文名 | file 字体文件
getVersionString
▸ getVersionString(): string
得当前程序的版本信息
Example
import { MxCpp } from "mxcad";
const version = MxCpp.App.getVersionString();
console.log("版本信息", version);
Returns
string
版本信息
init
▸ init(imp
): void
初始化 McAppType 对象。
Example
import { MxCpp } from "mxcad";
const imp = MxCpp.App.getImp();
MxCpp.App.init(imp);
Parameters
Name | Type | Description |
---|---|---|
imp | any | 传入的 imp 对象。 |
Returns
void
loadFonts
▸ loadFonts(vecShxFonst
, vecBigShxFonst
, vecTureTypeFonts
, retCall
): void
通知cad程序,将来要使用的字体需要加载,方便后面程序使用.
Example
import { MxCpp } from 'mxcad';
//修改文字样式
function Mx_Test_TrueText(){
let mxcad = MxCpp.getCurrentMxCAD();
//清空当前显示内容
mxcad.newFile();
MxCpp.App.loadFonts([], [], ["syadobe","simsun"], () => {
// 添加一个黑体文字样式
mxcad.AddTureTypeTextStyle("ht_style","syadobe");
// 添加一个宋体文字样式
mxcad.AddTureTypeTextStyle("st_style","simsun");
// 设置当前样式为黑体
mxcad.drawTextStyle = "ht_style";
mxcad.drawColor = new McCmColor(200, 255, 50);
let idText = mxcad.drawText(0, 3500, "绘图控件TrueType文字测试", 100, 0, 0, 1);
let ent = idText.getMcDbEntity();
// 修改文字样式为宋体
if(ent) ent.textStyle = "st_style";
mxcad.zoomAll();
mxcad.regen();
mxcad.updateDisplay();
});
}
Parameters
Name | Type | Description |
---|---|---|
vecShxFonst | string [] | shx字体 |
vecBigShxFonst | string [] | bigfont shx字体 |
vecTureTypeFonts | string [] | Truetype字体 |
retCall | () => void | 回调函数 |
Returns
void
mcedRGB2Index
▸ mcedRGB2Index(red
, green
, blue
, bAutoNearest?
): number
将 RGB 值转换为索引。
Example
import { MxCpp } from 'mxcad'
const colorIndex = MxCpp.App.mcedRGB2Index(255, 0, 0, bAutoNearest)
Parameters
Name | Type | Default value | Description |
---|---|---|---|
red | number | undefined | 红色值。 |
green | number | undefined | 绿色值。 |
blue | number | undefined | 蓝色值。 |
bAutoNearest | boolean | true | 是否自动获取最近的颜色值。 |
Returns
number
返回转换后的索引值。
objectIdIsKindOf
▸ objectIdIsKindOf(lIdIndex
, className
): boolean
判断一个对象id是否指类类型名对象
Example
import { MxCADUiPrEntity } from "mxcad";
// 选择目标对象
let selEntity = new MxCADUiPrEntity();
selEntity.setMessage("选择对象");
let val = await selEntity.go();
if (!val.isValid()) return;
// 判断目标对象是为多段线类
const isSuccess = MxCpp.objectIdIsKindOf(val.id, "McDbPolyline");
if(isSuccess){
console.log("目标对象为多段线")
}else{
console.log("目标对象不为多段线")
}
Parameters
Name | Type | Description |
---|---|---|
lIdIndex | number | 对象id索引 |
className | string | 对象名称 |
Returns
boolean
返回布尔值
objectIdToObject
▸ objectIdToObject(lIdIndex
): null
| McDbObject
将对象 id 转换为 McDbObject 对象。
Example
import { MxCADUiPrEntity, MxCpp } from "mxcad";
// 获取目标对象
let selEntity = new MxCADUiPrEntity();
let val = await selEntity.go();
if (!val.isValid()) return;
const obj = MxCpp.App.objectIdToObject(val.id);
console.log(obj)
Parameters
Name | Type | Description |
---|---|---|
lIdIndex | number | 对象的 id。 |
Returns
null
| McDbObject
返回转换后的 McDbObject 对象,如果转换失败,则返回 null。
setDefaultTrueTypeFontFile
▸ setDefaultTrueTypeFontFile(sTrueTypeFontName
): void
配置默认的TrueType字体
Example
import { MxCpp } from "mxcad";
//设置默认TrueType字体为Arial.ttf
MxCpp.setDefaultTrueTypeFontFile("Arial.ttf");
Parameters
Name | Type | Description |
---|---|---|
sTrueTypeFontName | string | TrueType字体名 |
Returns
void
setDefaultViewBackgroundColor
▸ setDefaultViewBackgroundColor(red
, green
, blue
): void
设置默认的视区的背景色.
Example
import { MxCpp } from 'mxcad'
MxCpp.App.setDefaultViewBackgroundColor(0, 0, 0)
Parameters
Name | Type | Description |
---|---|---|
red | number | 红色值。 |
green | number | 绿色值。 |
blue | number | 蓝色值。 |
Returns
void
setFontFilePath
▸ setFontFilePath(path
): void
配置字体加载位置,默值是fonts
Parameters
Name | Type | Description |
---|---|---|
path | string | 字体文件路径 |
Returns
void