Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Grid

A 2-D matrix that keeps track of notes and can enable, disable, and play them

Hierarchy

  • Grid

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Grid(width: number, height: number, noteLength?: number, makeInstruments?: (width: number, height: number, noteLength: number) => SynthInstrument[]): Grid

  • Creates a new Grid player

    Parameters

    • width: number

      The width of the grid in tiles

    • height: number

      The height of the grid in tiles

    • Optional noteLength: number
    • makeInstruments: (width: number, height: number, noteLength: number) => SynthInstrument[] = makeDefaultInstruments

        • Parameters

          • width: number
          • height: number
          • noteLength: number

          Returns SynthInstrument[]

    Returns Grid

Properties

Private _data

_data: readonly ITile[]

Private _height

_height: number

Private _width

_width: number

Readonly currentInstrument

currentInstrument: 0 = 0

Index of the current instrument that's being placed with setTileValue

Private defaultNoteLength

defaultNoteLength: boolean

Private instruments

instruments: SynthInstrument[]

Private makeInstruments

makeInstruments: (width: number, height: number, noteLength: number) => SynthInstrument[]

Type declaration

    • Parameters

      • width: number
      • height: number
      • noteLength: number

      Returns SynthInstrument[]

Private noteLength

noteLength: number

Accessors

data

  • get data(): readonly ITile[]

height

  • get height(): number

instrumentCount

  • get instrumentCount(): number

width

  • get width(): number

Methods

clearAllTiles

  • clearAllTiles(): void

dispose

  • dispose(): void

getPlayheadX

  • getPlayheadX(): number

getTileValue

  • getTileValue(x: number, y: number, instrument?: number): boolean

  • Gets whether a grid tile is currently lit up (armed)

    Parameters

    • x: number

      The x position, measured in grid tiles

    • y: number

      The y position, measured in grid tiles

    • instrument: number = ...

    Returns boolean

    Whether the tile is lit up

setCurrentInstrument

  • setCurrentInstrument(instrumentId: number): void

setMuted

  • setMuted(muted: boolean): void

  • Sets whether the ToneMatrix grid is muted.

    Parameters

    • muted: boolean

      True for muted, false for unmuted

    Returns void

setSize

  • setSize(newWidth?: number, newHeight?: number, newNoteLength?: null | number | typeof DEFAULT): void

  • Update the size of the grid. Note: If shrinking, tiles outside the space of new grid will be lost

    Parameters

    • newWidth: number = ...

      New width in tiles

    • newHeight: number = ...

      New height in tiles

    • Optional newNoteLength: null | number | typeof DEFAULT

      New note length. If not set, use previous value, or recalculate the default if using the default value previously. If using the DEFAULT symbol explicitly recalculate the default.

    Returns void

setTileValue

  • setTileValue(x: number, y: number, bool: boolean, instrument?: number): void

  • Sets whether a grid tile is currently lit up (armed)

    Parameters

    • x: number

      The x position, measured in grid tiles

    • y: number

      The y position, measured in grid tiles

    • bool: boolean

      Whether the tile should be turned on (true) or off (false)

    • instrument: number = ...

    Returns void

toggleTileValue

  • toggleTileValue(x: number, y: number, instrument?: number): void

  • Toggles whether a grid tile is currently lit up (armed)

    Parameters

    • x: number

      The x position, measured in grid tiles

    • y: number

      The y position, measured in grid tiles

    • instrument: number = ...

    Returns void

Generated using TypeDoc