GMSequencer | SuperCollider 3.13.0 Help

Description

GMSequencer is an easy to use customisable multiple checkbox, that is designed to be used as a sequencer.

It manipulates an Array containing either 0 or 1. The size of the provided array determines the size of the sequencer.

It can be updated within a Routine so that the current playing beat is highlighted. It can also be configured so that particular indices are highlighted.

Highlights are specified using an array of float between 0 and 1, that should be the size of the values. The higher the value is, the larger and opaque the highlight will be (see example below).

Specifying a beat property will highlight the associated checkbox. One can use a Routine (or any TempoClock based algorithm) to dynamically display the current beat. The graphical update is internally deferred. See example below.

Class Methods

.new

Creates a new instance of GMSequencer.

Its graphical properties are defined by its associated GMStyle.

Returns:

a GMSequencer instance.

Instance Methods

.action

Sets or gets the Function that will be evaluated when the GMSequencer has been interacted with. The arguments passed to the function depend on the actionMode.

.actionMode

Sets or gets which arguments are passed to the action's Function when the GMSequencer has been interacted with. If set to \values, the associated Array will be passed as argument. If set to \index, the index of the modified value and the new value will be passed as arguments.

.values

Sets or gets the sequencer values. Takes an Array containing only 0 or 1 as argument. The size of the array determines the size of the sequencer (i.e. the number of checkboxes).

.beat

Sets or gets the displayed beat. Set to -1 to disable. This will internally defer the graphical update.

.highlights

Sets or gets the policy that highlights checkboxes. Takes an Array containing floats between 0 and 1, that should be the size of the values. The closer the highlight is to 1, the larger and opaque the highlight will be.

.drawHighlights

Sets or gets wether the highlights should be displayed.

.symbol

Sets or gets the shape of the symbol used to display checked indices. Can either be \circle, \square, or \diamond.

.symbolRatio

Sets or gets the ratio of the symbol relative to the case size where it is displayed. Valid values are between 0 and 1.

.allowMouseMoveAction

Sets or gets whether the widget should respond to mouse move action when it is being pressed.

Internal Methods

.draw

Examples

(
s.waitForBoot({
    var triggers = [
        1, 0, 0, 0, 1, 0,
        1, 0, 0, 1, 1, 0
    ];

var routine;
    var routinePlaying = false;

var win = Window(
        "",
        Rect(
            100, 100,
            700, 100
        )
    );

var sequencer = GMSequencer()
    .values_(triggers)
    .highlights_([
        1, 0, 0.75, 0, 0.5, 0,
        1, 0, 0.75, 0, 0.5, 0
    ])
    .beat_(0)
    .action_({ |values| triggers = values;    });

routinePlaying = true;
        } {
            routine.stop;
            routinePlaying = false;
            // Reset beat display
            sequencer.beat_(0);
        };
    });

SynthDef(\GMWhitePerc, {
        var snd = WhiteNoise.ar(0.25);
        snd = snd * EnvGen.kr(
            Env.perc(0.01, 0.2),
            doneAction: Done.freeSelf
        );
        snd = BPF.ar(snd, 10000, 0.75);
        Out.ar(0, snd!2);
    }).add;

win.layout_(
        HLayout()
        .margins_(0)
        .spacing_(0)
        .add(playButton, 1)
        .add(sequencer, 7)
    );

CmdPeriod.doOnce({
        routinePlaying = false;
        win.close;
    });

win.onClose_({
        if(routinePlaying)
        { routine.stop; };
    });

win.front;
});
)

helpfile source: HelpSource/Classes/GMSequencer.schelp
link::GraphicalModule/Classes/GMSequencer::

GMSequencerExtension