Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Index

Constructors

constructor

Properties

Private _aes

_aes: PrintNode

The PrintNode that is printing the effect

Private _corner

_corner: GUIDE = GUIDE.NONE

Private _guideSize

_guideSize: number = 7

Private _id

_id: number

The ID of the effect

Private _isDragging

_isDragging: boolean = false

Private _isResizing

_isResizing: boolean = false

Private _isSelected

_isSelected: boolean = false

Private _justDragged

_justDragged: boolean = false

Private _justResized

_justResized: boolean = false

Private _node

_node: T

The node of the effect

Private _scope

_scope: Scope

The effect's scope

Abstract name

name: string

The name of the effect, used for logging

Accessors

aes

canvas

  • get canvas(): HTMLCanvasElement

color

  • get color(): string
  • set color(val: string): void

corner

  • get corner(): GUIDE
  • set corner(corner: GUIDE): void

ctx

  • get ctx(): CanvasRenderingContext2D

guideSize

  • get guideSize(): number

id

  • get id(): number
  • set id(id: number): void

isDragging

  • get isDragging(): boolean
  • set isDragging(val: boolean): void

isResizing

  • get isResizing(): boolean
  • set isResizing(val: boolean): void

isSelected

  • get isSelected(): boolean
  • set isSelected(val: boolean): void

justDragged

  • get justDragged(): boolean
  • set justDragged(val: boolean): void

justResized

  • get justResized(): boolean
  • set justResized(val: boolean): void

mouse

  • get mouse(): object
  • set mouse(mouse: object): void

node

  • get node(): T
  • set node(node: T): void

prevMouse

  • get prevMouse(): object
  • set prevMouse(mouse: object): void

scope

  • get scope(): Scope
  • set scope(scope: Scope): void

Methods

Private addEventListeners

  • addEventListeners(): void

Abstract contains

  • contains(): boolean
  • Returns true if the mouse is inside of the object's boundary, false if otherwise

    Returns boolean

delete

  • delete(): void

draw

  • draw(): void

Abstract drawGuides

  • drawGuides(): void

drawSingleGuide

  • drawSingleGuide(x: number, y: number, guide: GUIDE): void
  • Simple method that draws a single guide.

    Parameters

    • x: number

      x coordinate for the top left corner of the rectangle

    • y: number

      y coordinate for the top left corner of the rectangle

    • guide: GUIDE

    Returns void

Abstract guideContains

Private isMouseOutside

  • isMouseOutside(event: MouseEvent): void
  • Sets isDragging, isResizing and isSelected to false if the mouse clicks outside of the canvas

    Parameters

    • event: MouseEvent

      the mousedown event

    Returns void

Protected isOverlapped

  • isOverlapped(): boolean

Abstract logClick

Abstract logPaint

Abstract logResize

Abstract modifyDrag

  • modifyDrag(event: MouseEvent): void
  • Changes the x and y coordinates of the object in order to drag the object.

    Parameters

    • event: MouseEvent

    Returns void

Abstract modifyReset

  • modifyReset(): void
  • Resets all of the private booleans to false (like dragging, resizing, etc) when the mouse is released

    Returns void

Abstract modifyResize

  • modifyResize(event: MouseEvent): void
  • Changes the size of the object when called (when a corner guide is clicked and dragged).

    Parameters

    • event: MouseEvent

    Returns void

Abstract modifyState

  • modifyState(event: MouseEvent): void
  • Toggles all of the private booleans depending on the mouse position when called (onMouseDown) e.g. if the mouse is within the bounding rectangle when this is called, isSelected = true

    Parameters

    • event: MouseEvent

    Returns void

Abstract onKeyDown

  • onKeyDown(event: KeyboardEvent): void

Private onMouseDown

  • onMouseDown(event: MouseEvent): void
  • Called whenever the mouse clicks inside the canvas. Modifies the state depending on whether the guides contain the mouse or the bounding rect contains the mouse.

    Parameters

    • event: MouseEvent

      the mousedown event

    Returns void

Private onMouseMove

  • onMouseMove(event: MouseEvent): void
  • Called whenever the mouse moves within the canvas. Updates mouse position and calls the modify methods.

    Parameters

    • event: MouseEvent

      the mousemove event

    Returns void

Private onMouseUp

  • onMouseUp(event: MouseEvent): void
  • Called whenever the mouse unclicks. Calls modifyReset to reset dragging and resizing booleans among others.

    Parameters

    • event: MouseEvent

      the mouseup event

    Returns void

removeEventListeners

  • removeEventListeners(): void

Abstract toDragString

  • toDragString(): string

Abstract toIDString

  • toIDString(): string

Abstract toSelString

  • toSelString(): string

Abstract update

  • update(): void

Object literals

Private _mouse

_mouse: object

x

x: number = 0

y

y: number = 0

Private _prevMouse

_prevMouse: object

x

x: number = 0

y

y: number = 0

Generated using TypeDoc