Lume
    Preparing search index...

    Class LayoutAbstract

    A layout stores the data necessary to generate a visualizer in Lume. It returns the graphical components that make up the visualizer, along with the format it uses to process notes.

    Classes which extend Layout should be stateless -- all methods should run the same given the same input.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    getCanvasDrawers getCanvasSize getNoteTrackers

    Constructors

    Methods

    • Returns the CanvasDrawer objects used in the layout.

      Parameters

      Returns Graphic[]

      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.

    • Returns the canvas size of the layout.

      Returns { x: number; y: number }

      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.

    • 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[]

      When implementing this method, the order of the trackers doesn't matter.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods