Package Max

nodes

Interpolate data graphically

Description

The nodes object displays overlapping circular regions ("nodes") and outputs a list of interpolated weights based on the distance between a slider position and each node's center point. You can drag the slider with the mouse or set its position with a list of coordinates.

Arguments

None.

Attributes

bgcolor[4 floats]

Sets the nodes background color in RGBA format.

candycane[int]: 1

Sets the nodes object to use multiple colors for the nodes, with the color pattern repeating (like the stripes in a candycane) every N nodes (indicated by the integer argument).

candycane2[4 floats]

Sets the RGBA values for the second node color in candycane mode.

candycane3[4 floats]

Sets the RGBA values for the third node color in candycane mode.

candycane4[4 floats]

Sets the RGBA values for the fourth node color in candycane mode.

candycane5[4 floats]

Sets the RGBA values for the fifth node color in candycane mode.

candycane6[4 floats]

Sets the RGBA values for the sixth node color in candycane mode.

candycane7[4 floats]

Sets the RGBA values for the seventh node color in candycane mode.

candycane8[4 floats]

Sets the RGBA values for the eighth node color in candycane mode.

clickmoveinactive[int]: 1
8.0.0

When disabled, inactive nodes cannot be moved using the mouse.

disabledalpha[float]: 0.4

Sets the transparency factor (between 0. and 1.) applied to the disabled nodes.

displayknob[int]: 0

Sets the display options for the slider. The display options are:
0: Hidden: the slider is not displayed.
1: Circle: the slider is displayed as a circle.
2: Picture: the slider uses a picture file. Possible values:

0 = 'Hidden'
1 = 'Circle'
2 = 'Picture'

dynamic[int]: 1
9.0.0

When enabled, dynamic updates the count and position of nodes based on the number of presets in a connected preset object. If the left outlet of nodes is not connected to the inlet of a preset, dynamic has no effect.

filternodeschanges[int]: 0
8.0.0

When enabled, the middle outlet will only output the data for each node when it is changed.

knobcolor[4 floats]

Sets the RGBA values for knob circle (when displayknob is set to circle).

knobpict[symbol]: <default>

The word knobpict , followed by the name of a file, will read any type of file into the nodes object and attempt to interpret it as a knob image (when displayknob is set to Picture).

knobsize[float]: 10.

Sets the knob size in pixels.

maxdynamicnodes[int]: 8
9.0.0

Sets the maximum number of nodes created for presets in a connected preset object.

mousemode[int]: 0

Sets the mouse behavior. Mouse behavior options are:
0: Automatic: allows the mouse to change the nodes position or the slider (if displayed).
1: Nodes: the mouse can only edit the nodes position and size.
2: Slider; the mouse can only changes the slider location. Possible values:

0 = 'Automatic'
1 = 'Nodes'
2 = 'Slider'

nodecolor[4 floats]

Sets the RGBA values for the first node.

nodenumber[atom_long]: 1

Sets the number of nodes.

nodesnames[64 symbols]: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64

Sets the display names of individual nodes

nsize[64 floats]

Sets the sizes of every node.

param_connect[symbol]:

Establishes a two-way connection between the object and a parameter of a compatible object with parameters such as gen~ or jit.gl.slab. The object can be used to change the value of the parameter and will update if the parameter value changes. The easiest way to set param_connect is with the attribute's menu in the inspector or the Connect submenu of the Object Action menu. The menu displays all available parameters of compatible objects.

Setting the param_connect attribute with a message requires the target parameter's path, which is the host object's scriping name followed by two colons and the parameter name. For example, for a gen~ object with scripting name gen~_AB , the path of the freq parameter would be gen~_AB::freq . You can set a value for the param_connect before the host object or parameter exists, and the object will connect to the parameter once it exists. Refer to the user guide entry for param_connect for more details.

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.

pointcolor[4 floats]

Sets the RGBA values for the center color of the node.

style[symbol]:
7.0.0

Sets the style to be applied to the object. Styles can be set using the Format Palette.

textcolor[4 floats]

Sets the RGBA values for the text.

xplace[64 floats]

Sets the x position of every node.

yplace[64 floats]

Sets the y position of every node.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

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. background 1 adds the object to the background layer, background 0 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'

hidden[int]: 0

Toggles whether an object is hidden when the patcher is locked.

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]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

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

Outputs the nodes values out the second outlet.

list

Sets the position of the slider (if present) and outputs the new coefficients.

Arguments:
  • x [number]
  • y [number]

active

Sets the active state (0 disabled, 1 enabled) of the node(s). Index numbering for the nodes starts at 1. When the index is set to 0, it affects every node.

Arguments:
  • index [int]
  • state [int]

ad

Sets the position of the slider (if present) in polar coordinates (azimuth in degrees, distance) and outputs the new coefficients.

Arguments:
  • azimuth [float]
  • distance [float]

clear

TEXT_HERE

getactive

The word getactive causes the nodes object to send a list of the active states of every node out the dumpout outlet. An optional argument allows you to query the active state of a specific node.

Arguments:
  • index [int]

getad

The word getad causes the nodes object to send a list of polar coordinates of the slider out the dumpout outlet.

getnode

The word getnode causes the nodes object to send a list of the values of the node {x, y, size, active} of every node out the dumpout outlet. An optional argument allows you to query a specific node.

Arguments:
  • index [int]

getsize

The word getsize causes the nodes object to send a list of the values of the node size of every node out the dumpout outlet. An optional argument allows you to query a specific node.

Arguments:
  • index [int]

getxy

The word getxy causes the nodes object to send a list of cartesian coordinates of the slider out the dumpout outlet.

(mouse)

You can manipulate the nodes or the slider depending on the displayknob and mousemode attributes.

setnode

Sets the position of the node(s). Index numbering for the nodes starts at 1. When the index is set to 0, it affects every node. You can also provide additional arguments to define the size and active state.

Arguments:
  • index [int]
  • x [float]
  • y [float]
  • size [float]
  • active [int]

setnodead

Sets the position of the node(s) in azimuth (angle in degree) and distance. Index numbering for the nodes starts at 1. When the index is set to 0, it affects every node. You can also provide additional arguments to define the size and active state.

Arguments:
  • index [int]
  • azimuth [float]
  • distance [float]
  • size [float]
  • active [int]

setnodename

Sending the message setnodename followed by an integer and a symbol changes the displayed name for that node from its index value to the specified symbol.

Arguments:
  • nodename [list]

setsize

Sets the size of the specified node. Index numbering for the nodes starts at 1. When the index is set to 0, it affects every node.

Arguments:
  • index [int]
  • size [float]

See Also

Name Description
multislider Display data as sliders or a scrolling display
pictslider Picture-based slider control
pattrstorage Save and recall pattr presets