Module Duplex.Applications.Matrix

Take control of the pattern matrix in Renoise

View the README.md (github)

Functions

__init (VarArg) Constructor method
_update_slots () update slots visual appeareance
start_app () inherited from Application
on_idle () inherited from Application
on_new_document () inherited from Application
_check_page_change () check if we need to change page, but update only when following play-pos called when page changes and when "follow_player" is enabled
_update_track_navigation () update track navigator, on new song, and when tracks have been changed
_update_seq_navigation () updateseqnavigation
_has_next_seq_page () hasnextseq_page
_has_prev_seq_page () hasprevseq_page
_has_next_track_page () hasnexttrack_page
_has_prev_track_page () hasprevtrack_page
_update_seq_page_count () updateseqpage_count
_update_track_page_count () updatetrackpage_count
_update_range () update range in sequence trigger
_update_position (idx) update index in sequence trigger called when starting/stopping playback, changing page
_retrigger_pattern () retrigger the current pattern
_set_trigger_mode () set the current trigger mode, depending on options
_get_play_page () get the currently playing page
_get_edit_page () get the currently edited page
_follow_track () when following the active track in Renoise, we call this method it will check if we are inside the current page, and update if not
_get_track_page (track_idx) figure out the active "track page" based on the supplied track index
_get_track_page_width () get track page width
_build_app () inherited from Application
_attach_to_song () add notifiers to relevant parts of the song

Tables

_loop_sequence_range (table) the loop sequence range

Fields

self._controls (table) keep references to UI controls here
self._width (int) width of the matrix grid
self._height (int) height of the matrix grid
self._playing (bool) true if currently playing
self._play_page (int) the currently playing page
self._edit_page (int) current edit page
self._seq_page_count (int) the total number of sequence pages
self._track_page_count (int) the total number of track pages
self._track_offset (int) the current track offset
self._track_page (int) the current track page
self._scheduled_pattern (int) scheduled sequence index
self._playback_pos (renoise.SongPos) current playback pos
self._update_slots_requested idle flags


Functions

__init (VarArg)
Constructor method

Parameters:

  • VarArg )

See also:

_update_slots ()
update slots visual appeareance
start_app ()
inherited from Application

Returns:

    bool or nil

See also:

on_idle ()
inherited from Application

See also:

on_new_document ()
inherited from Application

See also:

_check_page_change ()
check if we need to change page, but update only when following play-pos called when page changes and when "follow_player" is enabled
_update_track_navigation ()
update track navigator, on new song, and when tracks have been changed
_update_seq_navigation ()
updateseqnavigation
_has_next_seq_page ()
hasnextseq_page

Returns:

    bool
_has_prev_seq_page ()
hasprevseq_page

Returns:

    bool
_has_next_track_page ()
hasnexttrack_page

Returns:

    bool
_has_prev_track_page ()
hasprevtrack_page

Returns:

    bool
_update_seq_page_count ()
updateseqpage_count
_update_track_page_count ()
updatetrackpage_count
_update_range ()
update range in sequence trigger
_update_position (idx)
update index in sequence trigger called when starting/stopping playback, changing page

Parameters:

  • idx (integer) the index, 0 - song-end (use current position if undefined)
_retrigger_pattern ()
retrigger the current pattern
_set_trigger_mode ()
set the current trigger mode, depending on options
_get_play_page ()
get the currently playing page

Returns:

    int
_get_edit_page ()
get the currently edited page

Returns:

    int
_follow_track ()
when following the active track in Renoise, we call this method it will check if we are inside the current page, and update if not
_get_track_page (track_idx)
figure out the active "track page" based on the supplied track index

Parameters:

  • track_idx , renoise track number return integer (0-number of pages)
_get_track_page_width ()
get track page width

Returns:

    int
_build_app ()
inherited from Application

Returns:

    bool

See also:

_attach_to_song ()
add notifiers to relevant parts of the song

Tables

_loop_sequence_range
(table) the loop sequence range

Fields:

  • 1 (int) begin
  • 2 (int) end

Fields

self._controls
(table) keep references to UI controls here
self._width
(int) width of the matrix grid
self._height
(int) height of the matrix grid
self._playing
(bool) true if currently playing
self._play_page
(int) the currently playing page
self._edit_page
(int) current edit page
self._seq_page_count
(int) the total number of sequence pages
self._track_page_count
(int) the total number of track pages
self._track_offset
(int) the current track offset
self._track_page
(int) the current track page
self._scheduled_pattern
(int) scheduled sequence index
self._playback_pos
(renoise.SongPos) current playback pos
self._update_slots_requested
idle flags
generated by LDoc 1.4.2