bpatcher

Embed a visible subpatch inside a box

Description

bpatcher allows you to modularize the contents of a patcher or subpatcher for use in other patchers displaying only those visual elements which are specified or desired. The number of inlets and outlets in a bpatcher object is determined by the number of inlet and outlet objects contained in its subpatch window.

Arguments

None.

Messages

(drag) When a patcher file is dragged from the Max 5 File Browser to a bpatcher object, the file will be loaded.
(mouse) When the window containing the bpatcher object is locked (or the Command key on Macintosh or Control key on Windows is held down) and the mouse is clicked inside the bpatcher object’s box, the gesture is handled by the patch inside the box.
If the Shift and Command keys on Macintosh or Shift and Control keys on Windows are held down while clicking on a bpatcher object, dragging the mouse moves the upper-left corner of the visible part of the patch inside the box. The Assistance area of the patcher window shows the pixel values of the offset. If Enable Drag-Scrolling is unchecked in the bpatcher Inspector window, this feature is disabled.
If the Command and Option keys on Macintosh or Control and Alt keys on Windows are held down while clicking in a bpatcher object, a pop-up menu allows you to open the original file of the patch contained inside the box in its own window, or change the patch currently contained inside the box in its own window.
replace filename [symbol]
The replace message is intended for use in conjunction with scripting messages to the thispatcher object. If you send a replace message via an inlet to the bpatcher object, it will only work if there is no patcher inside the bpatcher; the inlet to the bpatcher object is used for sending messages into its subpatcher, not for sending messages to the bpatcher object itself.
To use the replace message feature via scripting messages, give your bpatcher object a Scripting Name using the Inspector, then use the message script sendbox <bpatcher-name> replace <patcher-name> to send the message to the named bpatcher object.

Attributes

Name Type g/s Description
args atom
def.:
When followed by a number of ints, floats, or symbols, this attribute lets you input arguments to your patcher which will be saved along with the main patch.
bgcolor float
def.:1. 1. 1. 1.
Sets the background color of the patcher visible in the bpatcher window.
bgmode int
def.:0
Sets the display mode for displaying the bpatcher's background color. The options are:

0: Transparent. The bpatcher window has no background color
1: Background Color. The bpatcher window uses the background color of the patcher
2: Override Background Color. The bpatcher window uses the color set using the Background Color attribute as the background color.
border int
def.:0
Toggles the drawing of a border around the bpatcher. This value can only be set using the Border setting in the bpatcher object's Inspector. The default appearance is unchecked (no border).
clickthrough int
def.:0
Toggles the ability to have any mouse activity inside the bpatcher window handled by the patch inside the box. This value can only be set using the Click-through setting in the bpatcher object's Inspector.
embed int
def.:0
Toggles the ability to embed the subpatch you are using and save it as part of the main patch (just as with a patcher object) instead of the subpatch being saved in a separate file. This value can only be set using the Embed Patcher in Parent setting in the bpatcher object's Inspector. The default behavior is 0 (save the subpatch as a separate file).
enablehscroll int
def.:0
Toggles the creation of a horizontal scrollbar in the bpatcher window for use in horizontally traversing a visible area of the embedded patcher. This value can only be set using the Enable Horizontal Scrollbar setting in the bpatcher object's Inspector.
enablevscroll int
def.:0
Toggles the creation of a vertical scrollbar in the bpatcher window for use in vertically traversing a visible area of the embedded patcher. This value can only be set using the Enable Vertical Scrollbar setting in the bpatcher object's Inspector.
lockeddragscroll int
def.:0
Enables/disables drag-scolling in the bpatcher window when the patcher is locked.
name symbol
def.:<none>
Designates the pathname of the patcher file for the bpatcher to use. This value can only be set using the Patcher File setting in the bpatcher object's Inspector.
offset float
def.:0. 0.
Specifies the number of pixels by which the upper left corner of the subpatch is to be offset horizontally and vertically within the bpatcher. If the subpatch being used in the bpatcher contains a thispatcher object connected to one of its inlet objects, the view of the subpatch can be changed by an offset message received in the corresponding inlet of bpatcher. In this way, a single bpatcher can be used to give different views of the subpatch. User interface objects in the subpatch that are partially outside the bpatcher object’s box will redraw completely (even outside the bounds of the bpatcher) in response to messages received in their inlet. It is therefore advised that user interface objects in the subpatch be either completely inside or completely outside the bpatcher object’s box.

Information for box attributes common to all objects

Output

(User-Defined): If the patcher being used in a bpatcher contains outlet objects, they will appear in corresponding left-to-right order as outlets in the bpatcher object's box.

Examples

View the contents of a subpatcher...... The contents of this patch can be windowed... ...using offset messages to a small bpatcher containing it

See Also

Name Description
patcher Create a subpatch within a patch
pcontrol Open and close subwindows within a patcher
thispatcher Send messages to a patcher
Max Interface Tutorial 1: bpatchers Max Interface Tutorial 1: bpatchers