rsc3/doc-schelp/HelpSource/Classes/NdefParamGui.scrbl

122 lines
2.8 KiB
Racket

#lang scribble/manual
@(require (for-label racket))
@title{NdefParamGui}
display the settings of a nodeproxy@section{categories}
Libraries>JITLib>GUI, Live Coding
@section{related}
Classes/EZText, Classes/NdefGui, Classes/EnvirGui
@section{description}
NdefParamGui displays all settings and mappings of a nodeproxy, so one can change them flexibly. Single number get displayed with an link::Classes/EZSlider::, and anything else is shown as an link::Classes/EZText:: (a text field). Its main use is within link::Classes/NdefGui::.
It inherits some useful methods from link::Classes/EnvirGui::.
@section{ClassMethods}
@section{subsection}
Creation
@section{method}
new
create a new NdefParamGui
@racketblock[
// simple example - see also NdefGui!
g = NdefParamGui.new(nil, 5); // empty with 5 slots
g.parent.alwaysOnTop_(true);
g.object_(Ndef(\a)); // put in a nodeproxy
Ndef(\a, { |freq = 300, amp = 0.2| SinOsc.ar(freq) * amp ! 2 }).play;
Ndef(\a).set(\freq, 200); // add a setting
Ndef(\a);
g.object_(nil); // put in nothing
g.object_(Ndef(\a)); // put in a nodeproxy
Ndef(\a).set(\amp, 0.125); // add a setting
Ndef(\a, { |freq = 300, amp = 0.2| SinOsc.ar(freq) * amp });
Ndef(\a).set(\freq, 234); // add a setting
Ndef(\a).play
Ndef(\lfo, { LFNoise0.kr([12, 8], 200).sum + 500 });
Ndef(\a).map(\freq, Ndef(\lfo));// mapped proxies are shown
g.useRanger = false;
//Multichannel controls are shown in EZText
g.putSpec(\freqs, \freq);
Ndef(\a, { |freqs = #[300, 303], pan, amp = 0.2| SinOsc.ar(freqs).sum * amp });
Ndef(\a).play
Ndef(\a).setn(\freqs, [300, 350])
Ndef(\a).setn(\freqs, [330, 350])
Ndef(\a).set(\harm, 123)
Ndef(\a).nodeMap.clear
Ndef(\lfos, { LFNoise0.kr([12, 8], 200) + 500 });
Ndef(\a).map(\freqs, Ndef(\lfos))
g.parent.close
::
]
@section{argument}
object
the nodeproxy whose settings are to be displayed.
@section{argument}
numItems
the number of items to display. If an envir is given, and no num, num is envir.size.
@section{argument}
parent
the parent view to display in; if none is given, a new window is created.
@section{argument}
bounds
the bounds within which to display; if none is given, bounds are calculated.
@section{argument}
makeSkip
flag whether to make a skipjack to manage updates of the envirgui. default is true.
@section{argument}
options
a list of additional information, e.g. flags about optional buttons.
@section{InstanceMethods}
@section{method}
name
if in its own window, set the window's name
@racketblock[
g.name = "Yoohoo";
::
]
@section{Examples}
@racketblock[
// put an NdefParamGui in an existing window - margin becomes 0@0
(
w = Window().front;
w.addFlowLayout;
g = NdefParamGui(Ndef(\a), 3, w);
NdefParamGui(Ndef(\c), 15, w);
)
// even
Ndef(\c).set(\otto, 123, \mops, [1,2,3], \kotzt, [0, 6, 0, 6]);
Ndef(\c).nodeMap.clear;
::
]