Slider2D | SuperCollider 3.13.0 Help

Location: NOT INSTALLED!

Description

A view that allows setting two numerical values represented by the horizontal and vertical position of a handle movable in two dimensions.

The values are always within the range between 0 and 1. Scaling the output and input values to your needs can easily be achieved by using a ControlSpec with its -map and -unmap methods.

The -step variable determines the amount by which the values will change when the handle is controlled using the keyboard. By default, holding down the Shift, Ctrl, or Alt key will multiply this amount by 100, 10, or 0.1 respectively, though you can customize this by setting -shift_scale, -ctrl_scale, or -alt_scale.

Drag and drop gives and accepts a Point of which the two coordinates represent the two values of the Slider2D.

Class Methods

Inherited class methods

Instance Methods

Data

.x

The value represented by the horizontal position of the handle. It will always be clipped to the range between 0 and 1.

Arguments:

A Float.

.y

The value represented by the vertical position of the handle. It will always be clipped to the range between 0 and 1.

Arguments:

A Float.

.activex

Sets -x and triggers the -action.

.activey

Sets -y and triggers the -action.

.setXY

Sets -x and -y to the two arguments.

.setXYActive

Sets -x and -y to the two arguments, and triggers the -action.

.incrementX

Increments -x by -step multiplied by factor.

.decrementX

Decrements -x by -step multiplied by factor.

.incrementY

Increments -y by -step multiplied by factor.

.decrementY

Decrements -y by -step multiplied by factor.

Appearance

.knobColor

The color of the handle.

Arguments:

A Color.

Interaction

.step

The amount by which -x or -y will change when incremented or decremented, either by calling relevant methods, or when related keys are pressed.

Arguments:

A Float.

.pixelStepX

The absolute amount by which -x would change if the handle moved horizontally by one pixel.

Returns:

A Float.

.pixelStepY

The absolute amount by which -y would change if the handle moved vertically by one pixel.

Returns:

A Float.

.shift_scale

The factor by which -step is multiplied when incrementing or decrementing the values by keyboard while the Shift key is pressed.

Arguments:

A Float.

.ctrl_scale

The factor by which -step is multiplied when incrementing or decrementing the values by keyboard while the Ctrl key is pressed.

Arguments:

A Float.

.alt_scale

The factor by which -step is multiplied when incrementing or decrementing the values by keyboard while the Alt key is pressed.

Arguments:

A Float.

Actions

.action

The action object evaluated whenever the user changes the position or size of the handle.

.defaultKeyDownAction

Implements the default effects of key presses as follows:

Key	Effect
r	x_(1.rand), y_(1.rand), and triggers action
n	x_(0), y_(0), and triggers action
x	x_(1), y_(1), and triggers action
c	x_(0.5), y_(0.5), and triggers action
up arrow	incrementY
down arrow	decrementY
right arrow	incrementX
left arrow	decrementX

Drag and drop

.defaultGetDrag

Returns:

A Point of which the x and y coordinates are set to -x and -y, respectively.

.defaultCanReceiveDrag

Returns:

True if the current drag data is a Point.

.defaultReceiveDrag

Sets -x and -y to the two coordinates of the Point stored as the current drag data, respectively, and triggers the -action.

Inherited instance methods

Examples

Drag an drop Points( w = Window("Slider2D", Rect(100, 100, 500, 300)); w.view.decorator = FlowLayout(w.view.bounds); t = Slider2D(w, Rect(20, 20, 280, 280)) .x_(0.5) // initial location of x .y_(1) // initial location of y .background_(Color.rand) .action_({|sl| [\sliderX, sl.x, \sliderY, sl.y].postln; }); t.step_(0.01); n = CompositeView.new(w, 200@300); n.decorator = FlowLayout(n.bounds); v = { |i| DragBoth.new(n, Rect(0, i * 20, 200, 20)).background_(Color.rand).align_(\center) }.dup(5); StaticText.new(n, 200@150).string_("hold down cmd and drag points from the slider to the drag slots, or reverse").stringColor_(Color.white); w.front; )

Shape a Sound( s.waitForBoot({ a = {arg mod = 0.05, index = 0.05; var r,out, out2; r = Saw.ar(8, 0.03); out = PMOsc.ar( 440, 660 * mod, 3 * index, 0, Lag.ar(r,0.01,1)); [out,Delay1.ar(out)]; }.play; w = Window("Slider2D", Rect(100,Window.screenBounds.height - 400, 300, 300)); w.view.decorator = FlowLayout(w.view.bounds); t = Slider2D(w, Rect(0, 0,292, 292)) .y_(0.05) .x_(0.05) .background_(Color.rand) .knobColor_(Color.rand) .action_({|sl| a.set(\mod,sl.x,\index,sl.y); }); w.front; CmdPeriod.doOnce({w.close}); }) )

helpfile source: https://github.com/supercollider/supercollider/tree/3.13/HelpSource/Classes/Slider2D.schelp
link::Classes/Slider2D::