mxcad_2d API 文档 / 2d / MxCADUiPrBase
Class: MxCADUiPrBase
2d.MxCADUiPrBase
MxCADUiPrBase 作为 MxCADUiPr* 系列的基类,提供了一些基础的功能。
Hierarchy
MxCADUiPrBase
Table of contents
Constructors
Properties
Methods
- abort
- cad2doc1
- cad2doc2
- clearLastInputPoint
- disableAllTrace
- doc2cad1
- doc2cad2
- drawReserve
- getCursorType
- getDetailedResult
- getDynamicInputType
- getInputToucheType
- getStatus
- isDisableDynInput
- isDisableDynamicTrace
- isDisableGridTrace
- isDisableOrthoTrace
- isDisableOsnap
- isDisablePolarAxisTrace
- isKeyWordPicked
- isOffsetInputPostion
- keyWordPicked
- keyWords
- message
- setCursorType
- setDisableDynInput
- setDisableDynamicTrace
- setDisableGridTrace
- setDisableOrthoTrace
- setDisableOsnap
- setDisablePolarAxisTrace
- setDynamicInputType
- setInputToucheType
- setKeyWords
- setLastInputPoint
- setMessage
- setOffsetInputPostion
- setUserDraw
- setUserInputControls
- userInputControls
Constructors
constructor
• new MxCADUiPrBase(imp
)
构造函数
Parameters
Name | Type | Description |
---|---|---|
imp | any | 内部实现对象 |
Properties
imp
• Protected
imp: any
内部实现对象
mxobj
• Protected
mxobj: MxDrawObject
MxDraw 实例对象
Methods
abort
▸ abort(cause?
): void
停止当前动态拖动
Parameters
Name | Type | Default value |
---|---|---|
cause | DetailedResult | DetailedResult.kCodeAbort |
Returns
void
void
cad2doc1
▸ Protected
cad2doc1(pt
): Vector3
cad坐标转文档坐标
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 三维点对象 |
Returns
Vector3
THREE.js点对象
cad2doc2
▸ Protected
cad2doc2(x
, y
, z
): Vector3
cad坐标转文档坐标
Parameters
Name | Type | Description |
---|---|---|
x | number | X轴值 |
y | number | Y轴值 |
z | number | Z轴值 |
Returns
Vector3
THREE.js点对象
clearLastInputPoint
▸ clearLastInputPoint(): void
清除上一次的输入点数据。
Returns
void
选择的关键字
disableAllTrace
▸ disableAllTrace(isDisable?
): void
禁用所有跟踪
Parameters
Name | Type | Default value |
---|---|---|
isDisable | boolean | true |
Returns
void
doc2cad1
▸ Protected
doc2cad1(pt
): McGePoint3d
文档坐标转cad坐标
Parameters
Name | Type | Description |
---|---|---|
pt | Vector3 | THREE.js坐标 |
Returns
三维点对象
doc2cad2
▸ Protected
doc2cad2(x
, y
, z
): McGePoint3d
文档坐标转cad坐标
Parameters
Name | Type | Description |
---|---|---|
x | number | X轴值 |
y | number | Y轴值 |
z | number | Z轴值 |
Returns
三维点对象
drawReserve
▸ drawReserve(callAddEntity?
): void
把动态绘制的对象,保留到图上。
Parameters
Name | Type | Description |
---|---|---|
callAddEntity? | (ent : Object3D ) => void | 回调参数ent 类型:THREE.THREE.Object3D |
Returns
void
点对象 DWG图纸坐标
getCursorType
▸ getCursorType(): MxCursorType
返回光标类型
Returns
MxCursorType
getDetailedResult
▸ getDetailedResult(): DetailedResult
返回交互操作退出的详细原因
Example
import { MxCADUiPrDist, DetailedResult } from 'mxcad';
const getDist = new MxCADUiPrDist();
const val = await getDist.go();
if (!val) return;
if (getDist.getDetailedResult() === DetailedResult.kCoordIn) {
console.log('提示输入', val)
}
Returns
DetailedResult
当前交互操作返回值类型
getDynamicInputType
▸ getDynamicInputType(): DynamicInputType
返回动态输入类型
Returns
DynamicInputType
动态输入显示类型
getInputToucheType
▸ getInputToucheType(): number
返回需要的Touche输入类型
Returns
number
getStatus
▸ getStatus(): MrxDbgUiPrBaseReturn
获取操作状态
Returns
MrxDbgUiPrBaseReturn
isDisableDynInput
▸ isDisableDynInput(): boolean
是否禁用动态输入框
Returns
boolean
isDisableDynamicTrace
▸ isDisableDynamicTrace(): boolean
是否禁用动态跟踪
Returns
boolean
isDisableGridTrace
▸ isDisableGridTrace(): boolean
是否禁用格网追踪
Returns
boolean
isDisableOrthoTrace
▸ isDisableOrthoTrace(): boolean
是否禁用正射追踪
Returns
boolean
isDisableOsnap
▸ isDisableOsnap(): boolean
是否禁用捕捉
Returns
boolean
isDisablePolarAxisTrace
▸ isDisablePolarAxisTrace(): boolean
是否禁用极轴跟踪
Returns
boolean
isKeyWordPicked
▸ isKeyWordPicked(matchKeyWord
): boolean
测试某一个关键字是否被用户选择
Example
//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad';
const getPoint = new MxCADUiPrPoint();
getPoint.setKeyWords("[选项1(A)/选项2(B)]");
const pt = await getPoint.go();
if(getPoint.isKeyWordPicked('A')){
console.log('选项1')
}else if(getPoint.isKeyWordPicked('B')){
console.log('选项2')
}
Parameters
Name | Type | Description |
---|---|---|
matchKeyWord | string | 要检测的关键字 |
Returns
boolean
true为真
isOffsetInputPostion
▸ isOffsetInputPostion(): boolean
是否输入点遍移一个距离
Returns
boolean
keyWordPicked
▸ keyWordPicked(): string
返回用户选择的关键字
Example
//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad';
const getPoint = new MxCADUiPrPoint();
getPoint.setKeyWords("[选项1(A)/选项2(B)]");
const pt = await getPoint.go();
const key = getPoint.keyWordPicked();
console.log(key)
Returns
string
选择的关键字
keyWords
▸ keyWords(): string
返回关键字列表
Returns
string
关键词列表
message
▸ message(): string
提示字符串
Returns
string
提示消息
setCursorType
▸ setCursorType(type
): void
设置光标类型
Parameters
Name | Type | Description |
---|---|---|
type | MxCursorType | 鼠标样式类型 |
Returns
void
setDisableDynInput
▸ setDisableDynInput(isDisable
): void
设置是否禁用动态输入框
Parameters
Name | Type |
---|---|
isDisable | boolean |
Returns
void
setDisableDynamicTrace
▸ setDisableDynamicTrace(isDisable
): void
设置是否禁用动态跟踪
Parameters
Name | Type | Description |
---|---|---|
isDisable | boolean | 是否禁用 |
Returns
void
setDisableGridTrace
▸ setDisableGridTrace(isDisable
): void
设置是否禁用格网追踪
Parameters
Name | Type | Description |
---|---|---|
isDisable | boolean | 是否禁用 |
Returns
void
setDisableOrthoTrace
▸ setDisableOrthoTrace(isDisable
): void
设置是否禁用正射追踪
Parameters
Name | Type | Description |
---|---|---|
isDisable | boolean | 是否禁用 |
Returns
void
setDisableOsnap
▸ setDisableOsnap(isDisable
): void
设置是否禁用捕捉
Parameters
Name | Type |
---|---|
isDisable | boolean |
Returns
void
setDisablePolarAxisTrace
▸ setDisablePolarAxisTrace(isDisable
): void
设置是否禁用极轴跟踪
Parameters
Name | Type | Description |
---|---|---|
isDisable | boolean | 是否禁用 |
Returns
void
setDynamicInputType
▸ setDynamicInputType(type
): void
设置动态输入类型
Parameters
Name | Type | Description |
---|---|---|
type | DynamicInputType | 动态输入显示类型 |
Returns
void
setInputToucheType
▸ setInputToucheType(toucheType
): void
设置需要的Touche输入类型,默认值是 MxType.InputToucheType.kGetBegan
Parameters
Name | Type |
---|---|
toucheType | number |
Returns
void
setKeyWords
▸ setKeyWords(keyWordList
): void
设置关键字列表
Example
//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad'
const getPoint = new MxCADUiPrPoint();
getPoint.setKeyWords("[选项1(A)/选项2(B)]")
Parameters
Name | Type | Description |
---|---|---|
keyWordList | string | 关键词列表 |
Returns
void
void
setLastInputPoint
▸ setLastInputPoint(pt
): void
设置上一次的输入点。
Parameters
Name | Type | Description |
---|---|---|
pt | McGePoint3d | 点对象 |
Returns
void
选择的关键字
setMessage
▸ setMessage(message
): void
设置提示字符串
Example
//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad'
const getPoint = new MxCADUiPrPoint();
getPoint.setMessage("\n提示消息")
Parameters
Name | Type | Description |
---|---|---|
message | string | 提示消息 |
Returns
void
提示消息
setOffsetInputPostion
▸ setOffsetInputPostion(isOffset
): void
设置输入点遍移一个距离
Parameters
Name | Type |
---|---|
isOffset | boolean |
Returns
void
setUserDraw
▸ setUserDraw(pDraw
): void
设置交互过程的动态绘制调用对象
Example
//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad';
const getPoint = new MxCADUiPrPoint();
getPoint.setUserDraw((pt,pw)=>{
console.log(pt, pw)
})
const pt = await getPoint.go();
Parameters
Name | Type | Description |
---|---|---|
pDraw | (currentPoint : McGePoint3d , pWorldDraw : McEdGetPointWorldDrawObject ) => void | McEdGetPointWorldDrawObject | 动态绘制调用对象 |
Returns
void
void
setUserInputControls
▸ setUserInputControls(contros
): void
设置输入控制设置,UserInputControls
Parameters
Name | Type |
---|---|
contros | number |
Returns
void
userInputControls
▸ userInputControls(): number
返回输入控制设置,UserInputControls
Returns
number