A newer version of Max is available. Click here to access the latest version of the Max documentation

pong Reference

Range limiting

pong

Description

Use the pong object to clip, fold, or wrap its input within the range of a low value and a high value.

Examples

pong limits the range of an input by folding it or wrapping it around an upper and lower threshold level

Arguments

low-value [float]

Optional

Default low range boundary

high-value [float]

Optional

Default high range boundary

Attributes

mode [symbol] (default: none)

Behaviour of limiting when input exceeds range. Options are clip, wrap, and fold. Possible values:

'none'
'clip'
'wrap'
'fold'

range [2 floats]

The range within which to keep values. Values outside of this range will be subject to a limiting algorithm chosen by the mode attribute.

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.

jspainterfile [symbol]

JS Painter File

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

int

Arguments

input [int]
Converted to float.

float

Arguments

input [float]
In left inlet: All incoming float values which exceed the high or low value ranges specified by arguments to the pong object are either folded back into this range, wrapped, or clipped according to the mode of the pong object.

In center inlet: Sets the low range boundary for the pong object.

In right inlet: Sets the high range boundary for the pong object.

list

Arguments

input [float]
In left inlet: Lists of numbers are processed together as per the float entry.

See Also

Name Description
clip Limit numbers to a certain range
pong~ Variable range signal folding