NdefGui | SuperCollider 3.14.0-dev Help

Description

NdefGui provides controls for handling and editing a NodeProxy or Ndef, and its monitors. NdefGui replaces NodeProxyEditor. It provides:

sliders for numerical settings
mapping of kr proxies to parameters
optional controls for playing / monitoring

Both NodeProxy and Ndef implement a .gui message, which returns a NdefGui for that NodeProxy. Overview: JITLib.

Note that when creating an NdefGui for an Ndef with very many parameters, it may create more sliders than can fit on the window or screen. In such cases, it is best to set a reasonable maximum for numItems:

Class Methods

Creation

NdefGui.new(object, numItems: 4, parent, bounds, makeSkip: true, options)

Arguments:

object	the nodeproxy to be shown and edited, or nil.
numItems	How many sliders or textviews for parameters to provide. Default value is 0.
parent	a parent view where NdefGui is to be shown. If nil, a window is made.
bounds	bounds where the view (or window) will be shown.
makeSkip	a flag whether to create and start a SkipJack for auto-updating.
options	an array of symbols for options of what to display. See list below.

Preset options lists which can be used in *new:

NdefGui.big

two lines of controls for a big NdefGui, usually in its own window

NdefGui.full

two lines of controls for a very big NdefGui

NdefGui.audio

for ar proxies, used in ProxyMixer left hand side

NdefGui.audioSm

for ar proxies, used in ProxyMixer.small on left hand side

NdefGui.control

for kr proxies, used in ProxyMixer mid section

Class Variables

NdefGui.buttonSizes

a dict for the sizes of the different gui elements.

NdefGui.buttonFuncs

a lookup dict for making the different buttons.

NdefGui.makeButFuncs

not a class var, but the method that inits buttonFuncs.

Inherited class methods

Instance Methods

Variables

See JITGui for more instance methods.

Various views the NdefGui has if they were present in the options:

.nameView

From superclass: JITGui

.typeView

.monitorGui

.paramGui

.fadeBox

.pauseBut

.sendBut

.edBut

.wakeBut

Basic Methods

.edits

the paramGui's widgets (usually, EZSliders)

.editKeys

the currently used param names

.highlight(index, prefix, color)

.unhighlight(index)

highlight and unhighlight a single slider by index

.highlightName(prefix: "", color)

.unhighlightName

highlight and unhighlight the nameView

.highlightParams(parOffset, num, highNames, clearOthers: true)

highlight a contiguous group of sliders; used for showing assigned MIDI faderboxes etc.

.addReplaceKey(replaced, replacer, spec)

.removeReplaceKey(replaced)

editKeys with technical names can be replaced with more user-friendly ones.

.proxy

.proxy = proxy

an alias to method object, object_

Standard JITGui Methods

.setDefaults(options)

.accepts(obj)

.getState

.checkUpdate

GUI Element Creation

.makeViews(options)

creates all the views given in the options list. Internally this calls the following methods:

.makeNameView(width, height)

.makeTypeView(width, height)

.makeClrBut(width, height)

.makeWakeBut(width, height)

.makeResetBut(width, height)

.makeScopeBut(width, height)

.makeDocBut(width, height)

.makeEndBut(width, height)

.makeFadeBox(width: 60, height: 18)

.makePauseBut(width, height)

.makeSendBut(width, height)

.makeEdBut(width, height)

.makeRipBut(width, height)

.makePollBut(width, height)

.makeMonitor(width, height, npOptions)

Inherited instance methods

Examples

Some configuration options

// numItems - sliders for setting parameters
n = NdefGui(Ndef(\a), 8);

// 4 sets of configurations are provided:
n = NdefGui(Ndef(\a), 0, options: NdefGui.control);
n = NdefGui(Ndef(\a), 0, options: NdefGui.audio);
n = NdefGui(Ndef(\a), 0, options: NdefGui.big);
n = NdefGui(Ndef(\a), 0, options: NdefGui.full);

NdefGui.control;    // used for control proxies in ProxyMixer/NdefMixer
// -> [\name, \pausR, \sendR, \poll, \ed]

NdefGui.audio;        // used for audio proxies in ProxyMixer/NdefMixer
// -> [\monitor, \playN, \name, \pausR, \sendR, \ed]

NdefGui.big;        // used for the big NdefGui in ProxyMixer/NdefMixer
// -> [\name, \type, \CLR, \reset, \scope, \doc, \end, \fade, \monitor, \playN, \pausR, \sendR, \poll]

// all of 'em
NdefGui.full;
// -> [\name, \type, \CLR, \reset, \scope, \doc, \end, \fade, \rip, \monitor, \playN, \pausR, \sendR, \poll, \ed]
/*
    // the choice of elements is:
    \name        a dragboth for the proxy's name
    \type        a view for the proxy's type (ir, ar + numChans, kr + numChans)
    \CLR         button to clear proxy
    \reset        button to reset proxy nodemap
    \scope        button to scope proxy
    \doc            button to document proxy as code
    \end            button to end proxy
    \fade        EZNumber for setting proxy fadetime

\monitor        MonitorGui for audio proxies
    \playN        a button for editing playN settings (within the MonitorGui)

\rip        (^)    button to open a new editor on the proxy (used in ProxyMixer/NdefMixer)

\pausR        a button to toggle proxy pause/resume
    \sendR        a button to re-send; alt-click tells the proxy to rebuild
    \poll        poll the proxy

* preset storage in JITLibExtensions, see ProxyPreset / NdefPreset

//     add your own functions to add your own elements, such as:
NdefGui.buttonSizes.put(\zoink, 60);
NdefGui.buttonFuncs.put(\zoink, { |ndgui| Button(ndgui.zone, 60@20).states_([["zoink"]]).action_({ ndgui.object.zoink }) });

n = NdefGui(Ndef(\a), 4, options: NdefGui.big ++ [\zoink]);

// make one and watch how the elements change
n = NdefGui(Ndef(\a), 4, options: NdefGui.big);

Ndef(\a).stop;
Ndef(\a).play;
Ndef(\a).vol_(0.3);
Ndef(\a).stop;

Ndef(\a).playN([2, 5]);   // does not display fully on outNumberBox
Ndef(\a).playN([2, 5], vol: 0.34);

// as in ProxyMixer, left side
n = NdefGui(Ndef(\a), options: NdefGui.audio);

// as in ProxyMixer control zone
n = NdefGui(Ndef(\a), 4, options: NdefGui.control);

// NdefGui default
n = NdefGui(options: NdefGui.big);

// and a few more
n = NdefGui(bounds: 400@20, options: NdefGui.full);

// put in a window - then no margin is added
(
w = Window().front;
w.addFlowLayout;
n = NdefGui(Ndef(\a), 4, w, options: NdefGui.big);
)

Ndef(\a, { |freq = 10| Blip.ar(freq) }).set(\freq, 200)
Ndef(\a, { |freq = 10, amp = 0.1| Blip.ar(freq) * amp })
Ndef(\a).set(\freq, 220)
Ndef(\a).set(\harm, 20)
Ndef(\a, { |freq = 10, amp = 0.1, harm = 20| Blip.ar(freq, harm) * amp })

Test - drag and drop proxies between NdefGuis

This seems broken in 3.7.0 - drags are sticky and can't be dropped.

Test - replacing keys

This is used in ProxyChain (JITLibExtensions).

helpfile source: /usr/local/share/SuperCollider/HelpSource/Classes/NdefGui.schelp
link::Classes/NdefGui::

NdefGui : JITGui : Object