Class KorgMicroKey

KorgMicroKey is a simple, physical layout based off of the KORG microKEY, a MIDI keyboard with 37 keys (3 octaves).

Hierarchy (View Summary)

Layout
- KorgMicroKey

Index

Constructors

Methods

getCanvasDrawers getCanvasSize getNoteTrackers

Constructors

constructor

new KorgMicroKey(): KorgMicroKey
Returns KorgMicroKey
Inherited from Layout.constructor

Methods

getCanvasDrawers

getCanvasDrawers(
    p5: __module,
    noteTrackers: NoteTracker[],
    timeTracker: TimeTracker,
    rConfig: RenderConfig,
): Graphic[]
Returns the CanvasDrawer objects used in the layout.
Parameters
- p5: __module
- noteTrackers: NoteTracker[]
- timeTracker: TimeTracker
- rConfig: RenderConfig
Returns Graphic[]
Remarks
CanvasDrawer objects are processed sequentially, from the first CanvasDrawer in the array, ot the last. When creating a new layout (implementing/overriding this method), keep the order of the CanvasDrawer array in mind, especially when the visualization has overlap.
Overrides Layout.getCanvasDrawers
- Defined in src/layouts/simple/physical/KorgMicroKey.ts:33

getCanvasSize

getCanvasSize(): { x: number; y: number }
Returns the canvas size of the layout.

Returns { x: number; y: number }
Remarks
The default (and recommended) canvas size is 850 by 850. This is because Lume was initally developed with this size, and the (non-custom) Graphic classes are designed with this limitation in mind.
Overrides Layout.getCanvasSize
- Defined in src/layouts/simple/physical/KorgMicroKey.ts:23

getNoteTrackers

getNoteTrackers(): NoteTracker[]
Returns the note trackers used for this layout. Lume will call this method first when building a layout. For simple layouts, this method will only return a single note tracker with no filter.

NoteTracker objects are processed separately from the other components as Lume needs direct access to the trackers to update them when processing the MIDI file.

Returns NoteTracker[]
Remarks
When implementing this method, the order of the trackers doesn't matter.
Overrides Layout.getNoteTrackers
- Defined in src/layouts/simple/physical/KorgMicroKey.ts:27