mxcad_2d API 文档 / 2d / MxCADUiPrString

Class: MxCADUiPrString ​

2d.MxCADUiPrString

UI交互 根据用户输入得到字符串

Example

import { MxCADUiPrString } from 'mxcad'

   const getStr = new MxCADUiPrString()
   getStr.setMessage("提示用户输入字符串:")
   const strVal = await getStr.go()
   console.log(strVal)

Hierarchy ​

• MxCADUiPrBase

  ↳ MxCADUiPrString

Table of contents ​

Constructors ​

• constructor

Properties ​

• imp
• mxobj

Methods ​

• abort
• cad2doc1
• cad2doc2
• clearLastInputPoint
• disableAllTrace
• doc2cad1
• doc2cad2
• drawReserve
• getCursorType
• getDetailedResult
• getDynamicInputType
• getInputToucheType
• getStatus
• go
• 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
• value

Constructors ​

constructor ​

• new MxCADUiPrString()

Overrides ​

MxCADUiPrBase.constructor

Properties ​

imp ​

• Protected imp: any

内部实现对象

Inherited from ​

MxCADUiPrBase.imp

mxobj ​

• Protected mxobj: MxDrawObject

MxDraw 实例对象

Inherited from ​

MxCADUiPrBase.mxobj

Methods ​

abort ​

▸ abort(cause?): void

停止当前动态拖动

Parameters ​

Returns ​

void

void

Inherited from ​

MxCADUiPrBase.abort

cad2doc1 ​

▸ Protected cad2doc1(pt): Vector3

cad坐标转文档坐标

Parameters ​

Returns ​

Vector3

THREE.js点对象

Inherited from ​

MxCADUiPrBase.cad2doc1

cad2doc2 ​

▸ Protected cad2doc2(x, y, z): Vector3

cad坐标转文档坐标

Parameters ​

Returns ​

Vector3

THREE.js点对象

Inherited from ​

MxCADUiPrBase.cad2doc2

clearLastInputPoint ​

▸ clearLastInputPoint(): void

清除上一次的输入点数据。

Returns ​

void

选择的关键字

Inherited from ​

MxCADUiPrBase.clearLastInputPoint

disableAllTrace ​

▸ disableAllTrace(isDisable?): void

禁用所有跟踪

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.disableAllTrace

doc2cad1 ​

▸ Protected doc2cad1(pt): McGePoint3d

文档坐标转cad坐标

Parameters ​

Returns ​

McGePoint3d

三维点对象

Inherited from ​

MxCADUiPrBase.doc2cad1

doc2cad2 ​

▸ Protected doc2cad2(x, y, z): McGePoint3d

文档坐标转cad坐标

Parameters ​

Returns ​

McGePoint3d

三维点对象

Inherited from ​

MxCADUiPrBase.doc2cad2

drawReserve ​

▸ drawReserve(callAddEntity?): void

把动态绘制的对象，保留到图上。

Parameters ​

Returns ​

void

点对象 DWG图纸坐标

Inherited from ​

MxCADUiPrBase.drawReserve

getCursorType ​

▸ getCursorType(): MxCursorType

返回光标类型

Returns ​

MxCursorType

Inherited from ​

MxCADUiPrBase.getCursorType

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

当前交互操作返回值类型

Inherited from ​

MxCADUiPrBase.getDetailedResult

getDynamicInputType ​

▸ getDynamicInputType(): DynamicInputType

返回动态输入类型

Returns ​

DynamicInputType

动态输入显示类型

Inherited from ​

MxCADUiPrBase.getDynamicInputType

getInputToucheType ​

▸ getInputToucheType(): number

返回需要的Touche输入类型

Returns ​

number

Inherited from ​

MxCADUiPrBase.getInputToucheType

getStatus ​

▸ getStatus(): MrxDbgUiPrBaseReturn

获取操作状态

Returns ​

MrxDbgUiPrBaseReturn

Inherited from ​

MxCADUiPrBase.getStatus

go ​

▸ go(): Promise<null | string>

开始动态拖动

Returns ​

Promise<null | string>

void

isDisableDynInput ​

▸ isDisableDynInput(): boolean

是否禁用动态输入框

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisableDynInput

isDisableDynamicTrace ​

▸ isDisableDynamicTrace(): boolean

是否禁用动态跟踪

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisableDynamicTrace

isDisableGridTrace ​

▸ isDisableGridTrace(): boolean

是否禁用格网追踪

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisableGridTrace

isDisableOrthoTrace ​

▸ isDisableOrthoTrace(): boolean

是否禁用正射追踪

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisableOrthoTrace

isDisableOsnap ​

▸ isDisableOsnap(): boolean

是否禁用捕捉

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisableOsnap

isDisablePolarAxisTrace ​

▸ isDisablePolarAxisTrace(): boolean

是否禁用极轴跟踪

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isDisablePolarAxisTrace

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 ​

Returns ​

boolean

true为真

Inherited from ​

MxCADUiPrBase.isKeyWordPicked

isOffsetInputPostion ​

▸ isOffsetInputPostion(): boolean

是否输入点遍移一个距离

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isOffsetInputPostion

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

选择的关键字

Inherited from ​

MxCADUiPrBase.keyWordPicked

keyWords ​

▸ keyWords(): string

返回关键字列表

Returns ​

string

关键词列表

Inherited from ​

MxCADUiPrBase.keyWords

message ​

▸ message(): string

提示字符串

Returns ​

string

提示消息

Inherited from ​

MxCADUiPrBase.message

setCursorType ​

▸ setCursorType(type): void

设置光标类型

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setCursorType

setDisableDynInput ​

▸ setDisableDynInput(isDisable): void

设置是否禁用动态输入框

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableDynInput

setDisableDynamicTrace ​

▸ setDisableDynamicTrace(isDisable): void

设置是否禁用动态跟踪

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableDynamicTrace

setDisableGridTrace ​

▸ setDisableGridTrace(isDisable): void

设置是否禁用格网追踪

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableGridTrace

setDisableOrthoTrace ​

▸ setDisableOrthoTrace(isDisable): void

设置是否禁用正射追踪

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableOrthoTrace

setDisableOsnap ​

▸ setDisableOsnap(isDisable): void

设置是否禁用捕捉

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableOsnap

setDisablePolarAxisTrace ​

▸ setDisablePolarAxisTrace(isDisable): void

设置是否禁用极轴跟踪

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisablePolarAxisTrace

setDynamicInputType ​

▸ setDynamicInputType(type): void

设置动态输入类型

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDynamicInputType

setInputToucheType ​

▸ setInputToucheType(toucheType): void

设置需要的Touche输入类型,默认值是 MxType.InputToucheType.kGetBegan

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setInputToucheType

setKeyWords ​

▸ setKeyWords(keyWordList): void

设置关键字列表

Example

//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad'
   const getPoint = new MxCADUiPrPoint();
   getPoint.setKeyWords("[选项1(A)/选项2(B)]")

Parameters ​

Returns ​

void

void

Inherited from ​

MxCADUiPrBase.setKeyWords

setLastInputPoint ​

▸ setLastInputPoint(pt): void

设置上一次的输入点。

Parameters ​

Returns ​

void

选择的关键字

Inherited from ​

MxCADUiPrBase.setLastInputPoint

setMessage ​

▸ setMessage(message): void

设置提示字符串

Example

//以 MxCADUiPrPoint 类示例
import { MxCADUiPrPoint } from 'mxcad'
   const getPoint = new MxCADUiPrPoint();
   getPoint.setMessage("\n提示消息")

Parameters ​

Returns ​

void

提示消息

Inherited from ​

MxCADUiPrBase.setMessage

setOffsetInputPostion ​

▸ setOffsetInputPostion(isOffset): void

设置输入点遍移一个距离

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setOffsetInputPostion

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 ​

Returns ​

void

void

Inherited from ​

MxCADUiPrBase.setUserDraw

setUserInputControls ​

▸ setUserInputControls(contros): void

设置输入控制设置，UserInputControls

Parameters ​

Returns ​

void

Inherited from ​

MxCADUiPrBase.setUserInputControls

userInputControls ​

▸ userInputControls(): number

返回输入控制设置，UserInputControls

Returns ​

number

Inherited from ​

MxCADUiPrBase.userInputControls

value ​

▸ value(): string

得以获取的字符串

Returns ​

string