rslider
Display or change a range of numbers
Description
Set a value range from the lowest to highest value.
Discussion
In the right inlet, the number is taken as one end of the range. The left inlet sets the other end. Drawing the range with the mouse always outputs the lowest value out the left outlet and the highest out the right.
Shift-clicking extends the range instead of replacing it. Command-clicking (Macintosh) or Control-double-clicking (Windows) and dragging shifts the current range values up or down. Option-clicking (Macintosh) or Alt-clicking (Windows) and dragging up or down expands or shrinks the currently selected range. Command-double-clicking (Macintosh) or Control-double-clicking (Windows) selects the entire range.
Arguments
None.
Attributes
bgcolor[4 floats]
Sets the background color of the rslider object in RGBA format.
bordercolor[4 floats]
Sets the border color of the rslider object in RGBA format.
drawline[int]: 1
Toggles the drawing of a center line on the rslider display. The default value is 1 (on).
fgcolor[4 floats]
Sets the range color of the rslider object in RGBA format.
floatoutput[atom_long]: 0
Toggles floating-point output from the slider object. The default is 0 (off).
listmode[int]: 0
Toggles the list output mode. When it is on, the rslider object will output the min and max values as a list out the left outlet. Otherwise, the values are sent out the right and left outlets. The default value is 0 (off).
min[float]: 0.
Sets value that will be added to the rslider object's lower value before it is sent out the outlet.
mult[float]: 1.
Sets a multiplier value. The rslider object's value will be multiplied by this number before it is sent out the outlet. The default value is 1.
orientation[int]: 0
Sets the rslider object to a horizontal or vertical data display.
: (the default) sets the display dependent on the size of the slider - longest side of the rectangle that describes the slider sets the orientation.
Possible values:
0 = 'Automatic'
1 = 'Horizontal'
2 = 'Vertical'
param_connect[symbol]:
Connect to Parameter
parameter_enable[int]
Enables use of this object with Max for Live Parameters and setting initial parameter values in Max.
parameter_mappable[int]: 1
When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.
size[float]: 128.
style[symbol]:
7.0.0
Sets the style to be applied to the object. Styles can be set using the Format Palette.
thickness[float]: 80.
Sets the thickness of the rslider knob. The default value is 80.
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer.
adds the object to the background layer, removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
JS Painter File
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Parameter Attributes
Orderint
Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.
Parameter Mode Enableint
Parameter Mode Enable (not available from Parameters window)
Link to Scripting Nameint
When checked, the Scripting Name is linked to the Long Name attribute.
Long Namesymbol
The long name of the parameter. This name must be unique per patcher hierarchy.
Short Namesymbol
Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.
Typeint
Specifies the data type. The data types used in Max for Live are:
Float
Int
Enum (enumerated list)
Blob
Note: By convention, the Live application uses floating point numbers
for its calculations; the native integer representation is limited to 256
values, with a default range of 0-255 (similar to the char data type used
in Jitter). When working with Live UI objects whose integer values will
exceed this range, the Type attribute should be set to Float,
and the Unit Style attribute should be set to Int.
Range/Enumlist
When used with an integer or floating point data type, this field is
used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains
a space-delimited list of the enumerated values (if list items contain a
space or special characters, the name should be enclosed in double
quotes).
Clip Modulation Modeint
Sets the Clip Modulation Mode used by the Live application. The modulation
modes are:
None
Unipolar
Bipolar
Additive
Absolute
Clip Modulation Rangelist
This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.
Initial Enableint
When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).
Initiallist
Sets the initial value to be stored and used when the Initial Enable attribute is checked.
Unit Styleint
Sets the unit style to be used when displaying values. The unit style
values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values
Custom Unitssymbol
Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").
Exponentfloat
When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.
Stepsint
The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.
Parameter Visibilityint
For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.
Update Limit (ms)int
Speed limits values triggered by automation.
Defer Automation Outputint
Defers values triggered by automation.
Messages
bang
In left inlet: Sends out the minimum and maximum values of the currently displayed range.
int
In left inlet: The number sets the minimum limit of a range displayed as a colored region on the rslider, and causes the minimum and maximum values of that range to be sent out. A number that exceeds the limits of the rslider itself will be limited to stay within the rslider.
The minimum and maximum values can also be set (and sent out) by dragging with the mouse across a range in the rslider.
- minimum
[int]
(inlet1)
In right inlet: The number is stored as the maximum limit of the range displayed in color on the rslider. A number that exceeds the limits of the rslider itself will be limited to stay within the rslider.
The minimum and maximum values can also be set (and sent out) by dragging with the mouse across a range in the rslider.
- maximum
[int]
float
Converted to
.- minimum
[float]
(inlet1)
In right inlet: The number is stored as the maximum limit of the range displayed in color on the rslider. A number that exceeds the limits of the rslider itself will be limited to stay within the rslider.
The minimum and maximum values can also be set (and sent out) by dragging with the mouse across a range in the rslider.
- maximum
[float]
list
In left inlet: The first two numbers in the list are used to set the minimum and maximum values of the displayed range, and are sent out.
- minimum
[int]
- maximum
[int]
(mouse)
Clicking on the rslider object and dragging sets the minimum and maximum values and sends them out the object's outlets (or left outlet in list mode). or setting attributes.
set
In left inlet: The word
, followed by two numbers, sets the minimum and maximum values of the currently displayed range, without sending them out the outlets.- minimum
[int]
- maximum
[int]
setminmax
The word rslider object. The floatoutput attribute will automatically be set.
, followed by two numbers, sets the low and high range values for the- low
[int]
- high
[int]
Output
int
The maximum value of the displayed range is sent out the right outlet, and the minimum value is sent out the left outlet. Output is triggered by a new minimum value (or a rslider.
) received in the left inlet, or by clicking or dragging the mouse in theSee Also
Name | Description |
---|---|
multislider | Display data as sliders or a scrolling display |
nslider | Output numbers from a notation display |
pictctrl | Picture-based control |
pictslider | Picture-based slider control |
slider | Move a slider to output values |
split | Look for a range of numbers |