Class SelectTool

A class to add a selection tool. It allows to select and drag a shape.

Hierarchy

Tool
- SelectTool

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

id

id: string = "select"

Id of the tool

isDown

isDown: boolean

Is the pointer down.

lastPoint

lastPoint: object

last point where the cursor was.

Type declaration

x: number
y: number

moved

moved: boolean

If true, a shape was dragged.

selectedShapes

selectedShapes: Shape[]

List of selected shapes

shape

shape: Shape

Shape being dragged.

Methods

keyUp

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

Overrides Tool.keyUp
- Defined in View/ToolBar/Tools/SelectTool.ts:182
Parameters
- e: KeyboardEvent
- canvas: Canvas
Returns void

pointerCancel

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

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

pointerDown

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

Overrides Tool.pointerDown
- Defined in View/ToolBar/Tools/SelectTool.ts:39
Determines the shape that is selected, if any.

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/SelectTool.ts:145
Parameters
- e: PointerEvent
- canvas: Canvas
Returns void

pointerMove

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

Overrides Tool.pointerMove
- Defined in View/ToolBar/Tools/SelectTool.ts:71
Drags the selected shapes.

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/SelectTool.ts:100
Emits events that a shape was dragged and/or selected.

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

Private selectShape

selectShape(shape: Shape): void

- Defined in View/ToolBar/Tools/SelectTool.ts:156
Selects a shape.

Parameters
- shape: Shape
  
  Shape to select.
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

Overrides Tool.toUnselect
- Defined in View/ToolBar/Tools/SelectTool.ts:196
To unselect

Returns void

unselectAllShapes

unselectAllShapes(): void

- Defined in View/ToolBar/Tools/SelectTool.ts:175
Unselects all shapes

Returns void

unselectShape

unselectShape(shape: Shape): void

- Defined in View/ToolBar/Tools/SelectTool.ts:165
Unselects a shape.

Parameters
- shape: Shape
  
  Shape to unselect.
Returns void

Generated using TypeDoc