Class CommentEditor

Hierarchy

CommentEditor
- CommentEditor

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CommentEditor(viewer: Viewer): CommentEditor

Overrides CommentEditor.constructor

Parameters
- viewer: Viewer
Returns CommentEditor

Properties

color

color: Color

commentType

commentType: CommentType

fontStyle

fontStyle: string

inputMap

inputMap: undefined | InputMap

lineWidth

lineWidth: number

viewer

viewer: Viewer

Methods

begin

begin(): Promise<boolean>

Inherited from CommentEditor.begin

Returns Promise<boolean>

destroy

destroy(): undefined

Inherited from CommentEditor.destroy

Returns undefined

end

end(): void

Inherited from CommentEditor.end

Returns void

exportImage

exportImage(): string

Inherited from CommentEditor.exportImage

Returns string

isDestroyed

isDestroyed(): boolean

Inherited from CommentEditor.isDestroyed

Returns boolean

keyDownCallback

keyDownCallback(evt: KeyboardEvent): void

Inherited from CommentEditor.keyDownCallback

Parameters
- evt: KeyboardEvent
Returns void

keyUpCallback

keyUpCallback(evt: KeyboardEvent): void

Inherited from CommentEditor.keyUpCallback

Parameters
- evt: KeyboardEvent
Returns void

onLeftDown

onLeftDown(movement: Vector2): void

Inherited from CommentEditor.onLeftDown

Parameters
- movement: Vector2
Returns void

onLeftUp

onLeftUp(): void

Inherited from CommentEditor.onLeftUp

Returns void

onMouseMove

onMouseMove(movement: Vector2): void

Inherited from CommentEditor.onMouseMove

Parameters
- movement: Vector2
Returns void

register

register(): void

Inherited from CommentEditor.register

Returns void

removeApplyType

removeApplyType(apply: ControlApplyType): void

Inherited from CommentEditor.removeApplyType

Parameters
- apply: ControlApplyType
Returns void

setApplyType

setApplyType(apply: ControlApplyType, downAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void, upAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void): void

Inherited from CommentEditor.setApplyType

Parameters
- apply: ControlApplyType
- downAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void
  - - (windowPosition: undefined | number | Vector2 | PitchPosition): void
    - Parameters
      - windowPosition: undefined | number | Vector2 | PitchPosition
      Returns void
- upAction: (windowPosition: undefined | number | Vector2 | PitchPosition) => void
  - - (windowPosition: undefined | number | Vector2 | PitchPosition): void
    - Parameters
      - windowPosition: undefined | number | Vector2 | PitchPosition
      Returns void
Returns void

setDrawingType

setDrawingType(type: CommentType): void

Inherited from CommentEditor.setDrawingType

Parameters
- type: CommentType
Returns void

setText

setText(position: Vector2, text: string): void

Inherited from CommentEditor.setText

Parameters
- position: Vector2
- text: string
Returns void