pattrmarker
Max Reference
Open Help

pattrmarker

Provide pattr communication between patchers

Description

The pattrmarker object associates a patcher with a global name, which can be used when looking up named objects. This permits, among other conveniences, name lookup and communication between two or more independent patcher hierarchies.

Examples

Discussion

The pattrmarker object provides the same basic functionality of the globalpatchername attribute of the patcher object.

Arguments

name [symbol]

The name for the parent patcher of the pattrmarker object in the pattr global namespace.

Attributes

invisible [int]

When enabled, the name of this pattrmarker object will not appear in the list reported by the getmarkerlist message.

name [symbol]

The global name of the parent patcher of the pattrmarker object.

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] (default: 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] (default: 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] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

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] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 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]

g/s(set)

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]

g/s(set)

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 [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

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

getmarkerlist

Arguments

all [int]
Reports a list of all registered names in the pattr global namespace from the pattrmarker object's outlet, prepended by the word markerlist . These names are reported whether they were registered via pattrmarker objects or via the globalpatchername attribute of the patcher object. With no argument, or an argument of 0 , the names of pattrmarker objects with the invisible attribute enabled will not appear in the reported list. With an argument of 1 , all names, regardless of the invisible status, will be reported.

reveal

Arguments

name [symbol]
Opens a view of the patcher referred to by the global name argument.

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
pattrhub Access all pattr objects in a patcher
pattrstorage Save and recall pattr presets