gate~
MSP Reference
Open Help

gate~

Route a signal to one of several outlets

Description

Use gate~ to route an input signal at the second inlet to one of several outlets, or to no outlet at all. When there is only one outlet (the default case), it acts as a simple switch. Unlike the Max gate object, any outlet which is not selected outputs a signal composed of zero values.

Examples

gate~ routes the input signal to one of its outlets, or shuts it off entirely

Arguments

number-of-outlets [int]

Optional

Number of outlets

initial-open-outlet [int]

Optional

Set the outlet that is initially selected. If 0, all signals are shut off and zero signals are sent out all outlets.

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] (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

int

Arguments

outlet-selected [int]
Select outlet to route input to. If the number is 0 or negative a zero signal is sent out. If the number is greater than the number of outlets, the signal is sent to the rightmost outlet. If a signal is connected to the left inlet, gate~ ignores int or float messages.

signal

In left inlet: Select outlet to route input to. If the number is 0 or negative a zero signal is sent out. If the number is greater than the number of outlets, the signal is sent to the rightmost outlet. If a signal is connected to the left inlet, gate~ ignores int or float messages.

In right inlet: The input signal to be passed through to one of the gate~ object's outlets, according to the most recently received int or float in the left inlet, or the value of the signal coming in the left inlet.

Output

signal

Depending on the value of the left inlet (either signal or number), one of the object's outlets will send out the input signal and rest will send out zero signals, or (if the inlet is closed) all outlets will send out zero signals.

See Also

Name Description
selector~ Assign one of several inputs to an outlet
matrix~ Signal routing and mixing matrix
gate Pass input to an outlet
MSP Basics Tutorial 4: Routing Signals MSP Basics Tutorial 4: Routing Signals
MSP Panning Tutorial 1: Simple panning MSP Panning Tutorial 1: Simple panning