Class TextMarkupTool

Hierarchy

TapMoveTapOnPlaneTool<TextMarkup>
- TextMarkupTool

Index

Constructors

Properties

getTextCallback markup name

Accessors

allowedSnapTypes enabled snapTypes Name

Methods

Constructors

constructor

new TextMarkupTool(api, model, markupSettings): TextMarkupTool
Parameters
- api: Api
- model: MarkupModel
- markupSettings: MarkupSettings
Returns TextMarkupTool
Overrides TapMoveTapOnPlaneTool<TextMarkup>.constructor
- Defined in packages/web3d-plugin-markup/src/Tools/TextMarkupTool.ts:16

Properties

getTextCallback

getTextCallback: ((markup) => string)

Type declaration

- (markup): string
- Parameters
  - markup: TextMarkup
  Returns string

markup

markup: TextMarkup

name

name: string

Accessors

allowedSnapTypes

get allowedSnapTypes(): SnapType[]
Returns SnapType[]
Inherited from TapMoveTapOnPlaneTool.allowedSnapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:20

enabled

get enabled(): boolean
Returns boolean
Inherited from TapMoveTapOnPlaneTool.enabled
- Defined in packages/web3d-plugin-markup/src/Tools/TapMoveTapOnPlaneTool.ts:92
set enabled(enabled): void
Parameters
- enabled: boolean
Returns void
Inherited from TapMoveTapOnPlaneTool.enabled
- Defined in packages/web3d-plugin-markup/src/Tools/TapMoveTapOnPlaneTool.ts:36

snapTypes

get snapTypes(): SnapType[]
Returns SnapType[]
Inherited from TapMoveTapOnPlaneTool.snapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:26
set snapTypes(value): void
Parameters
- value: SnapType[]
Returns void
Inherited from TapMoveTapOnPlaneTool.snapTypes
- Defined in packages/web3d-plugin-markup/src/Tools/MarkupTool.ts:30

`Static` Name

get Name(): string
Returns string
- Defined in packages/web3d-plugin-markup/src/Tools/TextMarkupTool.ts:12

Methods

add

add(startPick, endPick, color?, text?, origin?): TextMarkup
Parameters
- startPick: SnapPick
- endPick: SnapPick
- Optional color: Color
- Optional text: string
- Optional origin: any
Returns TextMarkup
Overrides TapMoveTapOnPlaneTool.add
- Defined in packages/web3d-plugin-markup/src/Tools/TextMarkupTool.ts:66

cancel

cancel(): void
Returns void
Overrides TapMoveTapOnPlaneTool.cancel
- Defined in packages/web3d-plugin-markup/src/Tools/TextMarkupTool.ts:41