Package Max

pattrhub

Access all pattr objects in a patcher

Description

Centralizes communication with all pattr objects in a patcher.

Discussion

The pattrhub object has a single inlet and two outlets. The inlet is used for all incoming messages. Messages that can be understood by a pattr object within the pattrhub object's patcher (e.g. get or set messages) will be automatically forwarded to that object, and any response will be sent from the pattrhub object's right outlet.

Arguments

None.

Attributes

bound[int]
read-only

Patcher is bound/valid

patcher[symbol]

The word patcher , followed by a symbol describing a valid path to a patcher, sets the patcher referenced by the pattrhub object. The default is the special symbol this , which represents the patcher the pattrhub object resides within. The pattrhub object can refer to patchers other than the one in which the object resides. A double-colon syntax ('::') is used to separate levels of patcher hierarchy. See the pattrhub help file for further information on this feature.

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]

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.

Messages

bang

bang is passed through the pattrhub object and output from its left outlet.

int

An int is passed through the pattrhub object and output from its left outlet.

Arguments:
  • input [int]

float

float is passed through the pattrhub object and output from its left outlet.

Arguments:
  • input [float]

list

list is passed through the pattrhub object and output from its left outlet.

Arguments:
  • input [list]

anything

Incoming messages to the pattrhub object are analyzed. If the first element of the message matches the name of a pattr- or autopattr-maintained object, the subsequent arguments in the message set that object's value. If the first element of the message matches get (name), where (name) matches the name of a pattr- or autopattr-maintained object, the value of that object is sent from the pattrhub object's right outlet, preceded by the object's name. Otherwise, the message is passed through the pattrhub object and output from its left outlet.

Arguments:
  • arguments [list]

getattributes

The getattributes message causes a list of all pattr- or autopattr-maintained object names to be output from the pattrhub object's right outlet, preceded by the symbol attributes .

getstate

The getstate message causes a series of lists to be output from the pattrhub object's right outlet -- one for every pattr- or autopattr-maintained object in the patcher containing the pattrhub object. Each list begins with the name of the object, and is followed by the object's current value.

Output

anything

Out left outlet: Any message not matching a get or set request to a pattr- or autopattr-maintained object in the pattrhub object's patcher is passed through the left outlet unchanged.

Out right outlet: get queries to the a pattr- or autopattr-maintained object in the pattrhub object's patcher are output from the right outlet, also known as the dumpout outlet.

See Also

Name Description
autopattr Expose multiple objects to the pattr system
pattr Provide an alias with a named data wrapper
pattrforward Send any message to a named object
pattrmarker Provide pattr communication between patchers
pattrstorage Save and recall pattr presets