Module xSequencerSelection
Static methods for working with pattern-sequence selections .
Sequence-selection
{
start_line, -- Start pattern line index (default = 1)
start_sequence, -- Start sequence index
end_line, -- End pattern line index (default = number_of_lines)
end_pattern -- End sequence index
}
Functions
| get_selected_range () | [Static] Retrieve the sequence selection |
| get_selected_range_length () | Retrieve the length (#indices) spanned by the selection |
| get_entire_range () | [Static] Retrieve a sequence selection representing the entire song |
| get_selected_index () | [Static] Get a sequence selection representing the selected pattern |
| get_pattern_selection () | [Static] Get a represention of the selected part of the current pattern |
| within_range (seq_range, songpos) | check if song-position is within a sequence range |
| pluck_from_range (seq_range, seq_idx, patt_num_lines) | retrieve the pattern-lines contained in a specific sequence-index |
| get_number_of_lines (seq_range) | look up song to determine the total number of lines in the range |
| shift_by_indices (seq_range, offset) | shift sequence indices by specified amount, confined to boundaries (modifies the seq_range in-place) |
| shift_forward (seq_range) | shift range forward by it's own size |
| shift_backward (seq_range) | shift range backward by it's own size |
| apply_to_pattern (seq_range) | apply the range to the currently selected pattern |
Functions
- get_selected_range ()
-
[Static] Retrieve the sequence selection
Returns:
-
table or nil if no selection is defined
- get_selected_range_length ()
-
Retrieve the length (#indices) spanned by the selection
Returns:
-
number (0 if no selection)
- get_entire_range ()
-
[Static] Retrieve a sequence selection representing the entire song
Returns:
-
table
- get_selected_index ()
-
[Static] Get a sequence selection representing the selected pattern
Returns:
-
table
- get_pattern_selection ()
-
[Static] Get a represention of the selected part of the current pattern
Returns:
-
table or nil if no selection exists
- within_range (seq_range, songpos)
-
check if song-position is within a sequence range
Parameters:
- seq_range (xSequenceSelection)
- songpos (renoise.SongPos, or songpos-alike table)
Returns:
-
bool
- pluck_from_range (seq_range, seq_idx, patt_num_lines)
-
retrieve the pattern-lines contained in a specific sequence-index
Parameters:
- seq_range (xSequenceSelection)
- seq_idx (number)
- patt_num_lines (number), optional (if undefined, derived from seq_idx)
Returns:
-
fromline (number), toline (number) or nil if outside range
- get_number_of_lines (seq_range)
-
look up song to determine the total number of lines in the range
Parameters:
- seq_range
Returns:
-
number
- shift_by_indices (seq_range, offset)
-
shift sequence indices by specified amount, confined to boundaries
(modifies the seq_range in-place)
Parameters:
- seq_range
- offset
- shift_forward (seq_range)
-
shift range forward by it's own size
Parameters:
- seq_range
- shift_backward (seq_range)
-
shift range backward by it's own size
Parameters:
- seq_range
- apply_to_pattern (seq_range)
-
apply the range to the currently selected pattern
Parameters:
- seq_range