Skip to content
On this page

[mxcad_2d API documentation] (../README. md)/[2d] (../modules/2d. md)/MxCADUiPrPoint

Class: MxCADUiPrPoint

2d.MxCADUiPrPoint

UI interaction point selection (mouse click on canvas)

Example

ts
import { MxCADUiPrPoint } from 'mxcad'
  const getPoint = new MxCADUiPrPoint();
GetPoint.setMessage ("Please set the first point")
  const point = await getPoint.go()
  console.log(point)

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

new MxCADUiPrPoint()

Constructor function

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();

Overrides

MxCADUiPrBase.constructor

Methods

abort

abort(cause?): void

Stop the current dynamic drag

Parameters

NameTypeDefault value
causeDetailedResultDetailedResult.kCodeAbort

Returns

void

void

Inherited from

MxCADUiPrBase.abort


basePt

basePt(): McGePoint3d

Obtain the base point for dynamic dragging

Returns

McGePoint3d

McGePoint3d

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
getPoint.setBasePt(new McGePoint3d(0,0,0));
await getPoint.go();
console.log(getPoint.basePt())//(0,0,0)

clearLastInputPoint

clearLastInputPoint(): void

Clear the previous input point data.

Returns

void

Example

ts
//Taking the MxCADUiPrPoint class as an example, the same applies to other classes in the MxCADUiPr * series
  import { MxCADUiPrPoint } from 'mxcad'

  const getPoint = new MxCADUiPrPoint();
  getPoint.clearLastInputPoint();

Inherited from

MxCADUiPrBase.clearLastInputPoint


disableAllTrace

disableAllTrace(isDisable?): void

Disable all tracking

Parameters

NameTypeDefault valueDescription
IsDisablebooleantrueIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.disableAllTrace(true);

Inherited from

MxCADUiPrBase.disableAllTrace


drawReserve

drawReserve(callAddEntity?): void

Keep the dynamically drawn objects on the graph.

Parameters

NameTypeDescription
callAddEntity?(ent: Objecti3D)=>voidcallback parameter ent type: THREE.THREE.Object3D

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
 import { MxCADUiPrPoint } from 'mxcad';

 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

Return cursor type

Returns

MxCursorType

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.getCursorType())

Inherited from

MxCADUiPrBase.getCursorType


getDetailedResult

getDetailedResult(): DetailedResult

Return detailed reasons for interactive operation exit

Returns

DetailedResult

The return value type of the current interactive operation

Example

ts
//Example of MxCADUiPrList class
  import { MxCADUiPrDist } from 'mxcad';
  import { DetailedResult } from "mxdraw";

  const getDist = new MxCADUiPrDist();
  const val = await getDist.go();
  if (!val) return;
  if (getDist.getDetailedResult() === DetailedResult.kCoordIn) {
Console.log ('prompt input', val)
   }

Inherited from

MxCADUiPrBase.getDetailedResult


getDocValue

getDocValue(): McGePoint3d

Obtain document coordinates

Returns

McGePoint3d

Point Object MdGePoint3d

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
await getPoint.go();
const pt = getPoint.getDocValue();
console.log(pt)

getDynamicInputType

getDynamicInputType(): DynamicInputType

Return dynamic input type

Returns

DynamicInputType

Dynamic input display type

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.getDynamicInputType())

Inherited from

MxCADUiPrBase.getDynamicInputType


getInputToucheType

getInputToucheType(): number

Return the required Touche input type

Returns

number

Touche input type

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint();
  const toucheType = getPoint.getInputToucheType();
  console.log(toucheType)

Inherited from

MxCADUiPrBase.getInputToucheType


getStatus

getStatus(): MrxDbgUiPrBaseReturn

Get operation status

Returns

MrxDbgUiPrBaseReturn

Operation status value

Example

ts
//Example of MxCADUiPrList class
 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) {
//Empty input
 }

Inherited from

MxCADUiPrBase.getStatus


go

go(): Promise<null | McGePoint3d>

Run the go method to return the Promise task for user interaction

Returns

Promise<null | McGePoint3d>

Return a promise object containing the coordinate points obtained by the user clicking on the page

Description

When the mouse clicks on the canvas, the Promise is completed and the coordinates of the clicked point are obtained Other interaction methods will return null, such as pressing the Esc cancel key or entering the corresponding keyword in the interaction

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
const pt = await getPoint.go();
console.log(pt)

isDisableDynInput

isDisableDynInput(): boolean

Do you want to disable dynamic input boxes

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisableDynInput())

Inherited from

MxCADUiPrBase.isDisableDynInput


isDisableDynamicTrace

isDisableDynamicTrace(): boolean

Do you want to disable dynamic tracking

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisableDynamicTrace())

Inherited from

MxCADUiPrBase.isDisableDynamicTrace


isDisableGridTrace

isDisableGridTrace(): boolean

Do you want to disable grid tracking

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisableGridTrace())

Inherited from

MxCADUiPrBase.isDisableGridTrace


isDisableOrthoTrace

isDisableOrthoTrace(): boolean

Do you want to disable ortho tracing

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisableOrthoTrace())

Inherited from

MxCADUiPrBase.isDisableOrthoTrace


isDisableOsnap

isDisableOsnap(): boolean

Do you want to disable capture

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisableOsnap())

Inherited from

MxCADUiPrBase.isDisableOsnap


isDisablePolarAxisTrace

isDisablePolarAxisTrace(): boolean

Do you want to disable polar tracking

Returns

boolean

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  console.log(getPoint.isDisablePolarAxisTrace())

Inherited from

MxCADUiPrBase.isDisablePolarAxisTrace


isKeyWordPicked

isKeyWordPicked(matchKeyWord): boolean

Test whether a certain keyword is selected by the user

Parameters

NameTypeDescription
MatchKeyWordstringKeywords to be detected

Returns

boolean

True is true

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint();
GetPoint. setKeyWords ("[Option 1 (A)/Option 2 (B)]");
  const pt = await getPoint.go();
  if(getPoint.isKeyWordPicked('A')){
Console.log (Option 1)
  }else if(getPoint.isKeyWordPicked('B')){
Console.log (Option 2)
  }

Inherited from

MxCADUiPrBase.isKeyWordPicked


isOffsetInputPostion

isOffsetInputPostion(): boolean

Do you want to input a point to move a distance

Returns

boolean

Inherited from

MxCADUiPrBase.isOffsetInputPostion


keyWordPicked

keyWordPicked(): string

Return the keywords selected by the user

Returns

string

Selected keywords

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint();
GetPoint. setKeyWords ("[Option 1 (A)/Option 2 (B)]");
  const pt = await getPoint.go();
  const key = getPoint.keyWordPicked();
  console.log(key)

Inherited from

MxCADUiPrBase.keyWordPicked


keyWords

keyWords(): string

Return keyword list

Returns

string

Keyword List

Example

ts
//Taking the MxCADUiPrPoint class as an example, the same applies to other classes in the MxCADUiPr * series
  import { MxCADUiPrPoint } from 'mxcad'
  const getPoint = new MxCADUiPrPoint();
GetPoint. setKeyWords ("[Option 1 (A)/Option 2 (B)]");
  const keyList = getPoint.keyWords();
Console.log ("Keyword List", keyList)//Keyword List [Option 1 (A)/Option 2 (B)]

Inherited from

MxCADUiPrBase.keyWords


message

message(): string

Prompt string

Returns

string

Reminder message

Example

ts
//Taking the MxCADUiPrPoint class as an example, the same applies to other classes in the MxCADUiPr * series
  import { MxCADUiPrPoint , McGePoint3d} from 'mxcad'

  const getPoint = new MxCADUiPrPoint();
GetPoint.setMessage ("Test Message");
console.log(getPoint.message());// Test information

Inherited from

MxCADUiPrBase.message


setBasePt

setBasePt(basePt): void

Set the base point for dynamic dragging

Parameters

NameTypeDescription
BasePt[McGePoint3d] (2d. McGePoint3d. md)Base point McGePoint3d

Returns

void

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
getPoint.setBasePt(new McGePoint3d(0,0,0));

setCursorType

setCursorType(type): void

Set cursor type

Parameters

NameTypeDescription
TypeMxCursorTypeMouse Style Type

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';
  import { MxCursorType } from "mxdraw";

  const getPoint = new MxCADUiPrPoint()
GetPoint.setMessage ("Specify text starting point: ")
  getPoint.setCursorType(MxCursorType.kCross);
  const pt = await getPoint.go();

Inherited from

MxCADUiPrBase.setCursorType


setDisableDynInput

setDisableDynInput(isDisable): void

Set whether to disable dynamic input boxes

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisableDynInput(true);

Inherited from

MxCADUiPrBase.setDisableDynInput


setDisableDynamicTrace

setDisableDynamicTrace(isDisable): void

Set whether to disable dynamic tracking

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisableDynamicTrace(true);

Inherited from

MxCADUiPrBase.setDisableDynamicTrace


setDisableGridTrace

setDisableGridTrace(isDisable): void

Set whether to disable grid tracking

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisableGridTrace(true);

Inherited from

MxCADUiPrBase.setDisableGridTrace


setDisableOrthoTrace

setDisableOrthoTrace(isDisable): void

Set whether to disable orthotracing

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisableOrthoTrace(true);

Inherited from

MxCADUiPrBase.setDisableOrthoTrace


setDisableOsnap

setDisableOsnap(isDisable): void

Set whether to disable capture

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisableOsnap(true);

Inherited from

MxCADUiPrBase.setDisableOsnap


setDisablePolarAxisTrace

setDisablePolarAxisTrace(isDisable): void

Set whether to disable polar tracking

Parameters

NameTypeDescription
IsDisablebooleanIs it disabled

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDisablePolarAxisTrace(true);

Inherited from

MxCADUiPrBase.setDisablePolarAxisTrace


setDynamicInputType

setDynamicInputType(type): void

Set dynamic input type

Parameters

NameTypeDescription
TypeDynamicInputTypeDynamic Input Display Type

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';
  import { DynamicInputType } from "mxdraw";

  const getPoint = new MxCADUiPrPoint()
  getPoint.setDynamicInputType(DynamicInputType.kXYCoordInput);

Inherited from

MxCADUiPrBase.setDynamicInputType


setInputToucheType

setInputToucheType(toucheType): void

Set the required Touche input type, default value is MxType InputToucheType.kGetBegan

Parameters

NameTypeDescription
ToucheTypeNumberToucheType Type

Returns

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint();
  getPoint.setInputToucheType(MxType.InputToucheType.kGetEnd);

Inherited from

MxCADUiPrBase.setInputToucheType


setKeyWords

setKeyWords(keyWordList): void

Set keyword list

Parameters

NameTypeDescription
KeyWordListstringKeyword List

Returns

void

void

Example

ts
//Taking the MxCADUiPrPoint class as an example, the same applies to other classes in the MxCADUiPr * series
  import { MxCADUiPrPoint } from 'mxcad'
  const getPoint = new MxCADUiPrPoint();
GetPoint. setKeyWords ("[Option 1 (A)/Option 2 (B)]")

Inherited from

MxCADUiPrBase.setKeyWords


setLastInputPoint

setLastInputPoint(pt): void

Set the previous input point.

Parameters

NameTypeDescription
PtMcGePoint3d (2d. McGePoint3d. md)Point Object

Returns

void

Example

ts
//Taking the MxCADUiPrPoint class as an example, the same applies to other classes in the MxCADUiPr * series
  import { MxCADUiPrPoint , McGePoint3d} from 'mxcad'

  const getPoint = new MxCADUiPrPoint();
  getPoint.setLastInputPoint(new McGePoint3d(0,0,0));

Inherited from

MxCADUiPrBase.setLastInputPoint


setMessage

setMessage(message): void

Set prompt string

Parameters

NameTypeDescription
messagestringprompt message

Returns

void

Reminder message

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad'

  const getPoint = new MxCADUiPrPoint();
GetPoint.setMessage ("prompt message")

Inherited from

MxCADUiPrBase.setMessage


setOffsetInputPostion

setOffsetInputPostion(isOffset): void

Set the input point to move a distance

Parameters

NameType
isOffsetboolean

Returns

void

Inherited from

MxCADUiPrBase.setOffsetInputPostion


setUseBasePt

setUseBasePt(useIt): void

Set the base point for dynamic dragging for dynamic drawing.

Parameters

NameTypeDescription
UseItbooleanWhether to set, setBasePt will automatically set true

Returns

void

void

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
getPoint.setUseBasePt(true);

setUserDraw

setUserDraw(pDraw): void

Set the dynamic drawing calling object for the interaction process

Parameters

NameTypeDescription
PDraw(CurrentPoint: [McGePoint3d] (2d. McGePoint3d. md), pWorldDraw: McEdGetPointWorldDrawObject)=>voidMcEdGetPointWorldDrawObject \

Returns

void

void

Example

ts
//Example of MxCADUiPrPoint class
  import { MxCADUiPrPoint } from 'mxcad';

  const getPoint = new MxCADUiPrPoint();
  getPoint.setUserDraw((pt,pw)=>{
    console.log(pt, pw)
  })
  const pt = await getPoint.go();

Inherited from

MxCADUiPrBase.setUserDraw


setUserInputControls

setUserInputControls(contros): void

Set input control settings

Parameters

NameType
controsnumber

Returns

void

Example

ts
//Example of MxCADUiPrInt class
  import { MxCADUiPrInt } from 'mxcad';
  import { UserInputControls } from "mxdraw"

  let getInt = new MxCADUiPrInt();
GetInt.setMessage ("Enter integer: ");
  getInt.setUserInputControls(UserInputControls.kNoZeroResponseAccepted);
  let iRowNum = await getInt.go();
  if (iRowNum == null) return;

Inherited from

MxCADUiPrBase.setUserInputControls


userInputControls

userInputControls(): number

Return to input control settings

Returns

number

Example

ts
//Example of MxCADUiPrInt class
  import { MxCADUiPrInt } from 'mxcad';

  let getInt = new MxCADUiPrInt();
  console.log(getInt.userInputControls())

Inherited from

MxCADUiPrBase.userInputControls


value

value(): McGePoint3d

Points that can be obtained

Returns

McGePoint3d

Point coordinates

Example

ts
import { MxCADUiPrPoint } from "mxcad"

const getPoint = new MxCADUiPrPoint();
await getPoint.go();
const pt = getPoint.value();
console.log(pt)