pong~

Variable range signal folding

Description

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

Examples

pong~ distorts a signal by folding it or wrapping it around an upper and lower threshold level

Discussion

The optional arguments are <mode> <lo val> <hi val>. mode 0 is fold, mode 1 is wrap. The default mode is fold. The default range is zero to one. If <hi val> is greater than <lo val>, their behavior is swapped. All inlets accept both signals and floats. The mode message may be used to switch between fold and wrap mode. It is useful for performing modulo arithmetic, as well as foldover or wraparound distortion.

Arguments

folding-mode [int]

Optional

An optional argument is used to set the mode of the pong~ A 0 sets signal folding (the default), and a 1 sets signal wrapping (see the mode message).

low-value [float]

Optional

When used with the optional mode argument, the low range value for the pong~ object can be specified by a float argument. If only one argument is given following the mode argument (e.g., pong~ 0 .1), it specifies the low range value of the pong~ object above which folding occurs, and the high range value is set to 1.0 (the default).

high-value [float]

Optional

When used with the optional mode argument, the high range value for the pong~ object can be specified by a float argument.

Attributes

mode [symbol]

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.

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

input [int]
In left inlet: All incoming signal, int, or float values which exceed the high or low value ranges specified by arguments to the pong~ object are either folded back into this range (i.e., values greater than one are reduced by one plus the amount that they exceed one, and negative values are handled similarly) or wrapped (i.e., values greater than one are reduced by two, and negative values are increased by two), according to the mode of the pong~ object (see the mode message).

In center or right inlet: The pong~ objects accepts low and high range values for the range outside of which folding occurs. If the pong~ object has either one or no arguments, pong~ will have two inlets. The right inlet is used to set the high range value above which signal folding occurs, the low range value is assumed to be zero.

If the pong~ object has two arguments, the object has three inlets. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit. The default object has no arguments, and the right inlet specifies the upper value.

If the current low range value is greater than the high range value, their behavior is swapped.

float

Arguments

input [float]
In left inlet: All incoming signal, int, or float values which exceed the high or low value ranges specified by arguments to the pong~ object are either folded back into this range (i.e., values greater than one are reduced by one plus the amount that they exceed one, and negative values are handled similarly) or wrapped (i.e., values greater than one are reduced by two, and negative values are increased by two), according to the mode of the pong~ object (see the mode message).

In center or right inlet: The pong~ objects accepts low and high range values for the range outside of which folding occurs. If the pong~ object has either one or no arguments, pong~ will have two inlets. The right inlet is used to set the high range value above which signal folding occurs, the low range value is assumed to be zero.

If the pong~ object has two arguments, the object has three inlets. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit. The default object has no arguments, and the right inlet specifies the upper value.

If the current low range value is greater than the high range value, their behavior is swapped.

signal

In left inlet: All incoming signal or float values which exceed the high or low value ranges specified by arguments to the pong~ object are either folded back into this range (i.e., values greater than one are reduced by one plus the amount that they exceed one, and negative values are handled similarly) or wrapped (i.e., values greater than one are reduced by two, and negative values are increased by two), according to the mode of the pong~ object (see the mode message).

In center or right inlet: The pong~ objects accepts low and high range values for the range outside of which folding occurs. If the pong~ object has either one or no arguments, pong~ will have two inlets. The right inlet is used to set the high range value above which signal folding occurs, the low range value is assumed to be zero.

If the pong~ object has two arguments, the object has three inlets. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit. The default object has no arguments, and the right inlet specifies the upper value.

If the current low range value is greater than the high range value, their behavior is swapped.

Output

signal

The folded signal or float value.

See Also

Name Description
phasewrap~ Wrap a signal between π and -π