WECHAT
微信
mail
mxcad

简体中文

English

简体中文

English

Appearance

mxcad_2d API 文档 / 2d / MxCADUiPrKeyWord

Class: MxCADUiPrKeyWord ​

2d.MxCADUiPrKeyWord

MxCADUiPrKeyWord 是一个用于交互式输入关键词选项的提示类。

Description

该类用于让用户从一组关键字中选择一个选项，例如“新增/修改/删除”、“自动/手动”、“是/否”等。 常用于命令分支选择和交互式参数确认，适合简化复杂命令的用户决策流程。 使用方法：

  1. new MxCADUiPrKeyWord() 创建关键字输入器；
  2. 调用 setKeyWords() 设置关键词列表；
  3. 调用 go() 等待用户选择；
  4. 获取返回值后使用 value() 或 keyWordPicked() 继续下一步逻辑。

Example

ts
import { MxCADUiPrKeyWord } from "mxcad";

const getKey = new MxCADUiPrKeyWord();
getKey.setMessage("请选择操作方式");
getKey.setKeyWords("[手动(M)/自动(A)]");
const key = await getKey.go();
if (!key) return;

console.log("用户选择：", key);

Hierarchy ​

Table of contents ​

Constructors ​

Methods ​

Constructors ​

constructor ​

• new MxCADUiPrKeyWord()

构造函数

Overrides ​

MxCADUiPrBase.constructor

Methods ​

abort ​

▸ abort(cause?): void

停止当前动态拖动

Parameters ​

NameTypeDefault value
causeDetailedResultDetailedResult.kCodeAbort

Returns ​

void

void

Inherited from ​

MxCADUiPrBase.abort

clearLastInputPoint ​

▸ clearLastInputPoint(): void

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

Returns ​

void

Inherited from ​

MxCADUiPrBase.clearLastInputPoint

disableAllTrace ​

▸ disableAllTrace(isDisable?): void

禁用所有跟踪

Parameters ​

NameTypeDefault valueDescription
isDisablebooleantrue是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.disableAllTrace

drawReserve ​

▸ drawReserve(callAddEntity?): void

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

Parameters ​

NameTypeDescription
callAddEntity?(ent: Object3D) => void回调参数ent 类型：THREE.THREE.Object3D

Returns ​

void

Example

ts
//以 MxCADUiPrPoint 类示例
 import { MxCADUiPrPoint } from 'mxcad';

 async function test(){
   const getPoint = new MxCADUiPrPoint();
   const basePt = new McGePoint3d(0, 0, 0);
   getPoint.setBasePt(basePt);
   getPoint.setUserDraw((pt,pw)=>{
   const line = new McDbLine(basePt, pt);
   pw.drawMcDbEntity(line)
   })
   const val = await getPoint.go();
   if (!val) return;
   getPoint.drawReserve()
 }

Inherited from ​

MxCADUiPrBase.drawReserve

getCursorType ​

▸ getCursorType(): MxCursorType

返回光标类型

Returns ​

MxCursorType

Inherited from ​

MxCADUiPrBase.getCursorType

getDetailedResult ​

▸ getDetailedResult(): DetailedResult

返回交互操作退出的详细原因

Returns ​

DetailedResult

当前交互操作返回值类型

Example

ts
//以 MxCADUiPrDist 类示例
  import { MxCADUiPrDist } from 'mxcad';
  import { DetailedResult } from "mxdraw";

  async function test(){
    const getDist = new MxCADUiPrDist();
    const val = await getDist.go();
    if (!val) return;
    if (getDist.getDetailedResult() === DetailedResult.kCoordIn) {
        console.log('提示输入', val)
    }
  }

Inherited from ​

MxCADUiPrBase.getDetailedResult

getDynamicInputType ​

▸ getDynamicInputType(): DynamicInputType

返回动态输入类型

Returns ​

DynamicInputType

动态输入显示类型

Inherited from ​

MxCADUiPrBase.getDynamicInputType

getInputToucheType ​

▸ getInputToucheType(): number

返回需要的Touche输入类型

Returns ​

number

Touche输入类型

Inherited from ​

MxCADUiPrBase.getInputToucheType

getLastInputPoint ​

▸ getLastInputPoint(): undefined | McGePoint3d

返回上一次的输入点。

Returns ​

undefined | McGePoint3d

选择的关键字

Inherited from ​

MxCADUiPrBase.getLastInputPoint

getResultPointOsnapMode ​

▸ getResultPointOsnapMode(): AcquirePointOsnapMode

返回交互取点操作得到的点的捕捉类型

Returns ​

AcquirePointOsnapMode

Inherited from ​

MxCADUiPrBase.getResultPointOsnapMode

getResultPointType ​

▸ getResultPointType(): AcquirePointType

返回交互取点操作得到的点类型

Returns ​

AcquirePointType

Inherited from ​

MxCADUiPrBase.getResultPointType

getStatus ​

▸ getStatus(): MrxDbgUiPrBaseReturn

获取操作状态

Returns ​

MrxDbgUiPrBaseReturn

操作状态值

Example

ts
//以 MxCADUiPrDist 类示例
 import { MxCADUiPrDist } from 'mxcad';
 import { MrxDbgUiPrBaseReturn } from "mxdraw";

 const getDist = new MxCADUiPrDist();
 const val = await getDist.go();
 if (!val) return;
 if(getPoint.getStatus() === MrxDbgUiPrBaseReturn.kNone) {
   // 空输入
 }

Inherited from ​

MxCADUiPrBase.getStatus

go ​

▸ go(): Promise<null | string>

开始动态拖动

Returns ​

Promise<null | string>

返回一个promise对象，包含了用户输入的关键字

Example

ts
import { MxCADUiPrKeyWord } from 'mxcad'

const getType = new MxCADUiPrKeyWord();
getType.setMessage('选择连接方式');
getType.setKeyWords('[手动逐个连线(H)/自动批量连线(A)]')
const type = await getType.go();
if (!type) return;

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

测试某一个关键字是否被用户选择

Parameters ​

NameTypeDescription
matchKeyWordstring要检测的关键字

Returns ​

boolean

true为真

Example

ts
  //以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint } from 'mxcad';

 async function test(){
   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')
   }
 }

Inherited from ​

MxCADUiPrBase.isKeyWordPicked

isOffsetInputPostion ​

▸ isOffsetInputPostion(): boolean

输入点是否偏移显示/处理

Returns ​

boolean

Inherited from ​

MxCADUiPrBase.isOffsetInputPostion

keyWordPicked ​

▸ keyWordPicked(): string

返回用户选择的关键字

Returns ​

string

选择的关键字

Example

ts
  //以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint } from 'mxcad';

  async function test(){
   const getPoint = new MxCADUiPrPoint();
   getPoint.setKeyWords("[选项1(A)/选项2(B)]");
   const pt = await getPoint.go();
   const key = getPoint.keyWordPicked();
   console.log(key)
  }

Inherited from ​

MxCADUiPrBase.keyWordPicked

keyWords ​

▸ keyWords(): string

返回关键字列表

Returns ​

string

关键词列表

Example

ts
//以 MxCADUiPrPoint 类示例，其他MxCADUiPr* 系列的类同理
  import { MxCADUiPrPoint } from 'mxcad'
  const getPoint = new MxCADUiPrPoint();
  getPoint.setKeyWords("[选项1(A)/选项2(B)]");
  const keyList = getPoint.keyWords();
  console.log("关键词列表", keyList)// 关键词列表 [选项1(A)/选项2(B)]

Inherited from ​

MxCADUiPrBase.keyWords

message ​

▸ message(): string

提示字符串

Returns ​

string

提示消息

Inherited from ​

MxCADUiPrBase.message

setCursorType ​

▸ setCursorType(type): void

设置光标类型

Parameters ​

NameTypeDescription
typeMxCursorType鼠标样式类型

Returns ​

void

Example

ts
//以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint } from 'mxcad';
  import { MxCursorType } from "mxdraw";

  async function test(){
   const getPoint = new MxCADUiPrPoint()
   getPoint.setMessage("指定文字起点:")
   getPoint.setCursorType(MxCursorType.kCross);
   const pt = await getPoint.go();
  }

Inherited from ​

MxCADUiPrBase.setCursorType

setDisableDynInput ​

▸ setDisableDynInput(isDisable): void

设置是否禁用动态输入框

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableDynInput

setDisableDynamicTrace ​

▸ setDisableDynamicTrace(isDisable): void

设置是否禁用动态跟踪

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableDynamicTrace

setDisableGridTrace ​

▸ setDisableGridTrace(isDisable): void

设置是否禁用格网追踪

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableGridTrace

setDisableOrthoTrace ​

▸ setDisableOrthoTrace(isDisable): void

设置是否禁用正射追踪

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableOrthoTrace

setDisableOsnap ​

▸ setDisableOsnap(isDisable): void

设置是否禁用捕捉

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisableOsnap

setDisablePolarAxisTrace ​

▸ setDisablePolarAxisTrace(isDisable): void

设置是否禁用极轴跟踪

Parameters ​

NameTypeDescription
isDisableboolean是否禁用

Returns ​

void

Inherited from ​

MxCADUiPrBase.setDisablePolarAxisTrace

setDynamicInputType ​

▸ setDynamicInputType(type): void

设置动态输入类型

Parameters ​

NameTypeDescription
typeDynamicInputType动态输入显示类型

Returns ​

void

Example

ts
//以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint } from 'mxcad';
  import { DynamicInputType } from "mxdraw";

  async function Mx_WindowZoom() {
    let getPoint = new MxCADUiPrPointTransform(MxInsidePublicFuns.getMxCADViewSpinMatrix(MxCpp.getCurrentMxCAD()));
    getPoint.disableAllTrace();
    getPoint.setMessage("\n点取缩放区域");
    getPoint.setDynamicInputType(DynamicInputType.kDynTip);
    let pt1 = await getPoint.go();
    if (pt1 == null) return;
    let mxcad = MxCpp.getCurrentMxCAD();
    getPoint.setUserDraw((p1, worldDraw) => {
        worldDraw.drawRect(MxCoordConvert.cad2doc1((pt1 as any)), MxCoordConvert.cad2doc1((p1 as any)));
    });

    let pt2 = await getPoint.go();
    if (pt2 == null) return;

    pt1.transformBy(getPoint.rmat);
    pt2.transformBy(getPoint.rmat);
    mxcad.zoomW(pt1, pt2);
 }

Inherited from ​

MxCADUiPrBase.setDynamicInputType

setInputToucheType ​

▸ setInputToucheType(toucheType): void

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

Parameters ​

NameTypeDescription
toucheTypenumbertoucheType类型

Returns ​

void

Example

ts
//以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint, MxCpp } from "mxcad";
  import { MxType } from "mxdraw";

   // 手机触模屏画直线
   async function Mx_Test_Touch_DrawLine() {
       const getPoint = new MxCADUiPrPoint();
       getPoint.setOffsetInputPostion(true);
       getPoint.setMessage("\n指定第一点:");
       // 接收 kGetBegan,触摸屏手指按下.
       getPoint.setInputToucheType(MxType.InputToucheType.kGetEnd);
       let pt1 = await getPoint.go();
       if (!pt1) return;
       getPoint.setMessage("\n指定第二点:");
       getPoint.setBasePt(pt1);

       console.log(getPoint.getResultPointOsnapMode());
       console.log(getPoint.getResultPointType());

       // 接收kGetEnd,触摸屏手指放开.
       getPoint.setInputToucheType(MxType.InputToucheType.kGetEnd);
       let pt2 = await getPoint.go();
       if (!pt2) return;
       let mxcad = MxCpp.getCurrentMxCAD();
       let ent = mxcad.drawLine(pt1.x, pt1.y, pt2.x, pt2.y).getMcDbEntity();
       if (ent) {
           ent.lineweight = 20;
       }
   }

Inherited from ​

MxCADUiPrBase.setInputToucheType

setKeyWords ​

▸ setKeyWords(keyWordList): void

设置关键字列表

Parameters ​

NameTypeDescription
keyWordListstring关键词列表

Returns ​

void

void

Example

ts
  //以 MxCADUiPrPoint 类示例, 其他MxCADUiPr* 系列的类同理
  import { MxCADUiPrPoint } from 'mxcad'
  const getPoint = new MxCADUiPrPoint();
  getPoint.setKeyWords("[选项1(A)/选项2(B)]")

Inherited from ​

MxCADUiPrBase.setKeyWords

setLastInputPoint ​

▸ setLastInputPoint(pt): void

设置上一次的输入点。

Parameters ​

NameTypeDescription
ptundefined | McGePoint3d点对象

Returns ​

void

Inherited from ​

MxCADUiPrBase.setLastInputPoint

setMessage ​

▸ setMessage(message): void

设置提示字符串

Parameters ​

NameTypeDescription
messagestring提示消息

Returns ​

void

提示消息

Inherited from ​

MxCADUiPrBase.setMessage

setOffsetInputPostion ​

▸ setOffsetInputPostion(isOffset): void

设置输入点遍移，常用于移动端取点

Parameters ​

NameType
isOffsetboolean

Returns ​

void

Example

ts
import { MxCADUiPrPoint } from "mxcad";
import { MxFun } from "mxdraw";

// 移动端 绘制临时标注圆
async function test(){
   const getPoint = new MxCADUiPrPoint();
   getPoint.setMessage("\n指定一点:");
   getPoint.setOffsetInputPostion(true);
   getPoint.clearLastInputPoint();
   let pt1 = (await getPoint.go());
   if (!pt1) return;

   let mxdraw = MxFun.getCurrentDraw();

   mxdraw.getTempMarkDraw().drawCircleMark(pt1.toVector3(), mxdraw.viewCoordLong2Cad(50), 0xFF0000);
   mxdraw.updateDisplay();
}

Inherited from ​

MxCADUiPrBase.setOffsetInputPostion

setOsModeExParam ​

▸ setOsModeExParam(lVal): void

设置捕捉时的扩展捕捉参数。

Parameters ​

NameTypeDescription
lValOsModeExParam扩展对象捕捉参数

Returns ​

void

Example

ts
import { MxCADUiPrPoint } from "mxcad";
import { OsModeExParam } from "mxdraw";

    async function Mx_Test_Rect2() {
        const getPoint = new MxCADUiPrPoint();
        getPoint.clearLastInputPoint();
        getPoint.setMessage("请选择第一个点");
        const pt1 = await getPoint.go();
        if (!pt1) return;

        const getNextPt = new MxCADUiPrPoint();
        getNextPt.setMessage("请选择第二个角点");
        getNextPt.setOsModeExParam(OsModeExParam.kCircleTangentOsmode);
        getNextPt.setUserDraw((pt2, pWorldDraw) => {
            let pl = new McDbPolyline();
            pl.addVertexAt(pt1);
            pl.addVertexAt(new McGePoint3d(pt1.x, pt2.y, pt1.z));
            pl.addVertexAt(pt2);
            pl.addVertexAt(new McGePoint3d(pt2.x, pt1.y, pt1.z));
            pl.isClosed = true;
            pWorldDraw.drawMcDbEntity(pl);
        });

        if (!await getNextPt.go()) return;

        getNextPt.drawReserve();
    }

Inherited from ​

MxCADUiPrBase.setOsModeExParam

setUserDraw ​

▸ setUserDraw(pDraw): void

设置交互过程的动态绘制调用对象

Parameters ​

NameTypeDescription
pDraw(currentPoint: McGePoint3d, pWorldDraw: McEdGetPointWorldDrawObject) => voidMcEdGetPointWorldDrawObject | 动态绘制调用对象

Returns ​

void

void

Example

ts
//以 MxCADUiPrPoint 类示例
  import { MxCADUiPrPoint } from 'mxcad';

  async function test(){
   const getPoint = new MxCADUiPrPoint();
   getPoint.setUserDraw((pt,pw)=>{
       pw.setColor(0xff00ff);
       pw.drawCircle(new HTREE.Vector3(pt.x,pt.y,pt.z), 10)
   })
   const pt = await getPoint.go();
   console.log("point", pt)
  }

Inherited from ​

MxCADUiPrBase.setUserDraw

setUserInputControls ​

▸ setUserInputControls(contros): void

设置输入控制设置

Parameters ​

NameType
controsnumber

Returns ​

void

Example

ts
// 以 MxCADUiPrInt 类示例
  import { MxCADUiPrInt } from 'mxcad';
  import { UserInputControls } from "mxdraw"

  let getInt = new MxCADUiPrInt();
  getInt.setMessage("输入整数:");
  getInt.setUserInputControls(UserInputControls.kNoZeroResponseAccepted);
  let iRowNum = await getInt.go();
  if (iRowNum == null) return;

Inherited from ​

MxCADUiPrBase.setUserInputControls

userInputControls ​

▸ userInputControls(): number

返回输入控制设置

Returns ​

number

Inherited from ​

MxCADUiPrBase.userInputControls

Copyright @ 2023 成都梦想凯德科技有限公司 Rights Reserved