Class FreeFormTool

A class to add a free form tool. It allows to draw free form shape.

Hierarchy

Tool
- FreeFormTool

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FreeFormTool(toolBar: ToolBar, selected: boolean): FreeFormTool

Overrides Tool.constructor
- Defined in View/ToolBar/Tools/FreeFormTool.ts:17
Parameters
- toolBar: ToolBar
- selected: boolean
Returns FreeFormTool

Properties

currentPoints

currentPoints: Point[]

List of points that define the current shape.

currentShape

currentShape: Selection<SVGGElement, any, any, any>

Shape being drawn.

id

id: string = "freeform"

Id of the tool.

isDown

isDown: boolean

Is the pointer down.

Methods

keyUp

keyUp(e: KeyboardEvent, canvas: Canvas): void

Inherited from Tool.keyUp
- Defined in View/ToolBar/Tools/Tool.ts:48
Parameters
- e: KeyboardEvent
- canvas: Canvas
Returns void

pointerCancel

pointerCancel(e: PointerEvent, canvas: Canvas): void

Overrides Tool.pointerCancel
- Defined in View/ToolBar/Tools/FreeFormTool.ts:85
Parameters
- e: PointerEvent
- canvas: Canvas
Returns void

pointerDown

pointerDown(e: PointerEvent, canvas: Canvas): void

Overrides Tool.pointerDown
- Defined in View/ToolBar/Tools/FreeFormTool.ts:29
Instanciates the current shape.

Parameters
- e: PointerEvent
  
  Pointer Event that triggered this function.
- canvas: Canvas
  
  Canvas where the event was triggered.
Returns void

pointerLeave

pointerLeave(e: PointerEvent, canvas: Canvas): void

Overrides Tool.pointerLeave
- Defined in View/ToolBar/Tools/FreeFormTool.ts:92
Parameters
- e: PointerEvent
- canvas: Canvas
Returns void

pointerMove

pointerMove(e: PointerEvent, canvas: Canvas): void

Overrides Tool.pointerMove
- Defined in View/ToolBar/Tools/FreeFormTool.ts:47
Add points to the current shape.

Parameters
- e: PointerEvent
  
  Pointer Event that triggered this function.
- canvas: Canvas
  
  Canvas where the event was triggered.
Returns void

pointerUp

pointerUp(e: PointerEvent, canvas: Canvas): void

Overrides Tool.pointerUp
- Defined in View/ToolBar/Tools/FreeFormTool.ts:64
Emit an event to signal the creation of a new shape.

Parameters
- e: PointerEvent
  
  Pointer Event that triggered this function.
- canvas: Canvas
  
  Canvas where the event was triggered.
Returns void

Protected setupUI

setupUI(toolBar: ToolBar, selected: boolean): void

Inherited from Tool.setupUI
- Defined in View/ToolBar/Tools/Tool.ts:15
Parameters
- toolBar: ToolBar
- selected: boolean
Returns void

toUnselect

toUnselect(): void

Inherited from Tool.toUnselect
- Defined in View/ToolBar/Tools/Tool.ts:50
Returns void

Generated using TypeDoc