GMLinesButton | SuperCollider 3.13.0 Help

Description

GMLinesButton is an easy to use customisable multi states button. It allows to order its buttons on multipe lines.

It does not discriminate button identifiers.

A note about this documentation

This class is an extension of GMMultiButton. The only difference between those two classes are their states specification, and the way their action is evaluated. Only those differences are documented here.

See GMMultiButton documentation for others methods documentation.

States and action arguments

Instead of taking an array of states as argument, GMLinesButton takes an array containing arrays of states as argument. This allows to arrange the buttons into several layers, which can ease the location of the desired button :( GMLinesButton() .states_([ ["A", "B", "C", "D", "E"], ["I", "II", "III"], ["a", "b", "c", "d"], ["1", "2", "3", "4", "5"] ]) .front )

The Function associated to the action will be evaluated with two arguments : first, the index of the selected array, then the index of the button within this array. In the previous example, clicking the "b" button would call the function with 2, 1 as arguments.

Class Methods

.new

Creates a new instance of GMLinesButton.

Its graphical properties are defined by its associated GMStyle.

Returns:

a GMLinesButton instance.

Instance Methods

GMMultiButton methods

See the GMMultiButton class documentation for those methods.

.action

.mouseDownAction

.mouseMoveAction

.states

.state

.allowRetrigger

.allowMouseMove

.free

.orientation

.desindex

.direction

.drawSelected

.fontRatio

.unselectedRatio

.setColorAll

.setFontColorAll

.displayAltValue

.svgRatio

Internal Methods

.draw

The function associated to the View's drawFunc. Shouldn't be modified

.prResizeSVGs

Examples

(
s.waitForBoot({
    var states = [
        ["Major", "Minor", "Pentatonic"],
        ["Dorian", "Phrygian", "Lydian", "Mixolydian", "Locrian"],
        ["Spanish", "Diminished", "Augmented", "Chromatic"]
    ];

var scales = [
        [\major, \minor, \minorPentatonic],
        [\dorian, \phrygian, \lydian, \mixolydian, \locrian],
        [\spanish, \diminished, \augmented, \chromatic]
    ];

var win = Window(
        "",
        Rect(
            100, 100,
            800, 300
        )
    );

var lButton = GMLinesButton()
    .states_(states)
    .allowRetrigger_(true)
    .fontRatio_(0.3)
    .action_({ |x, y|
        var routine;
        var scale = Scale.at(scales[x][y]).ratios;
        scale = scale ++ [2];

routine = Routine({
            scale.do({ |ratio|
                Synth(\GMPercSine, [\freq, 440 * ratio]);
                0.25.wait;
            });
            routine.stop;
        }).play(TempoClock.default);
    });

SynthDef(\GMPercSine, { |amp = 0.25, freq = 440|
        var snd = SinOsc.ar(freq, mul: amp);
        snd = snd * EnvGen.kr(
            Env.perc,
            doneAction: Done.freeSelf
        );
        Out.ar(0, snd!2);
    }).add;

win.layout_(
        VLayout()
        .margins_(0)
        .add(lButton)
    );

CmdPeriod.doOnce({ win.close; });
    win.front;
});
)

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

GMLinesButtonExtension