thispoly~
MSP Reference
Open Help

thispoly~

Control poly~ voice allocation and muting

Description

Use the thispoly~ object to control poly~ voice allocation and muting. When placed inside a patcher loaded by the poly~ object, it sends and receives messages from the poly~ object that loads it.

Examples

thispoly~ reports the instance number of its poly~ subpatcher

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

bang

Reports the instance number of the patch. The first instance is reported as 1 .

int

Arguments

busy-state [int]
Toggles the "busy" state for the patcher instance when the message busy 1 is received. The object will not receive messages generated by a note or midinote message to the left inlet of the parent poly~ object when the "busy" state is on.

mute

Arguments

mute-flag [int]
Disables DSP processing for the loaded instance of the patcher when the message mute 1 is received. This message can be combined with an int message which toggles the "busy" state of the patcher to create voices in a patcher which are only on while they play a "note".

signal

Sets the "busy" state of the patcher instance. The busy state for the patcher instance is set to 1 when the thispoly~ object receives a non-zero input signal. The busy state is set to 0 otherwise.

Output

int

Out left outlet: The instance number, starting at 1 , reported when thispoly~ receives the bang message. If the patcher containing thispoly~ was not loaded within a poly~ object, 0 is output.

int

Out right outlet: If the loaded instance of the patcher is muted, a 1 is output. If the instance is not muted, a 0 is output.

See Also

Name Description
in Message input for a patcher loaded by poly~ or pfft~
in~ Signal input for a patcher loaded by poly~
out Message output for a patcher loaded by poly~ or pfft~
out~ Signal output for a patcher loaded by poly~
poly~ Manage polyphony/DSP for patchers
MSP Polyphony Tutorial 1: Using the poly~ Object MSP Polyphony Tutorial 1: Using the poly~ Object