pcontrol
Open and close subwindows
Description
Serves as a remote control for patcher/subpatcher windows and functions.
Arguments
None.
Attributes
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.
Messages
close
Closes the patcher window of any subpatches or patcher objects connected to the pcontrol object's outlet.
- patcher
[list]
help
The word
, followed by a symbol, opens a help file in Max's max-help folder with the name of the symbol followed by .- filename
[symbol]
load
The word
, followed by the name of a patcher file, opens that file if it can be found in Max's search path. The file name may optionally be followed by up to nine numbers and/or symbols, which will be substituted for the appropriate changeable arguments ( to ) in the patch being opened.- filename
[list]
loadunique
The word
, followed by the name of a patcher file, opens a single instance that file if it can be found in Max's search path. If the file has already been loaded, the previously loaded copy will be activated (i.e. only a single copy of the file may be opened). As with the message, the file name may optionally be followed by up to nine numbers and/or symbols, which will be substituted for the appropriate changeable arguments ( to ) in the patch being opened.- patcher
[list]
open
Opens the patcher window of any subpatches or patcher objects connected to the pcontrol object's outlet.
- patcher
[list]
shroud
The word
, followed by the name of a patcher file, opens that file but does not show its window. (Use this message with care, since having patchers open but invisible can potentially lead to some disconcerting results.)- filename
[list]
shroudunique
TEXT_HERE
Output
Patcher-Control
Any subpatches or patcher objects connected to the pcontrol object's outlet can have their patcher window opened or closed, or MIDI and Audio enabled/disabled, when the appropriate message is received in the inlet of pcontrol. The word followed by a or a will turn MIDI and Audio on or off for a patcher connected to the pcontrol outlet. When followed by or , the message will also turn MIDI and Audio on or off for any subpatchers inside that connected patcher.
See Also
Name | Description |
---|---|
bpatcher | Embed a subpatch with a visible UI |
inlet | Receive messages from outside a patcher |
patcher | Create a subpatch within a patch |
thispatcher | Send messages to a patcher |