pong~
Variable range signal folding
Description
Use the pong~ object to clip, fold, or wrap its input within the range of a low value and a high value.
Discussion
The optional arguments are <mode> <lo val> <hi val>. mode 0 is fold, mode 1 is wrap, and mode 2 is clip. 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, wrap, and clip modes. 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), a 1 sets signal wrapping, and a 2 sets signal clipping (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.
Possible values:
'fold'
'wrap'
'clip'
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 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]
write-only
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]
write-only
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
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, wrapped, or clipped according to the mode of the pong~ object.
In center or right inlet: The pong~ object accepts low and high range values for the range outside of which folding occurs. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit.
If the current low range value is greater than the high range value, their behavior is swapped.
- input
[int]
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, wrapped, or clipped according to the mode of the pong~ object.
In center or right inlet: The pong~ object accepts low and high range values for the range outside of which folding occurs. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit.
If the current low range value is greater than the high range value, their behavior is swapped.
- input
[float]
signal
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, wrapped, or clipped according to the mode of the pong~ object.
In center or right inlet: The pong~ object accepts low and high range values for the range outside of which folding occurs. The center inlet specifies the low value range below which folding occurs, and the right inlet specifies the high range limit.
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 -π |