clip~
Description
Use the clip~ to constrain input signals between two specified values.
Examples
Arguments
minimum [float]
Initial minimum limit for the range of the output signal. If no argument is supplied, the minimum limit is initially set to 0. If a signal is connected to the middle inlet, the corresponding argument is ignored.
maximum [float]
Initial maximum limit for the range of the output signal. If no argument is supplied, the maximum limit is initially set to 0. If a signal is connected to the middle inlet, the corresponding argument is ignored.
Attributes
mode [int]
When the mode attribute is non-zero, clip~ outputs 0 for values above its maximum or below its minimum to 0. When mode is disabled, clip~ constrains its input between its minimum and maximum.
Possible values:
0 = 'Clip'
(
Clip input outside minimum and maxmimum
)
1 = 'Zero'
(
Zero input outside minimum and maxmimum
)
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]
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]
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]
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
float
Arguments
signal
In middle inlet: Minimum limit for the range of the output signal.
In right inlet: Maximum limit for the range of the output signal.
Output
signal
The input signal is sent out, limited within the specified range. Any value in the input signal that exceeds the minimum or maximum limit is set equal to that limit.
See Also
| Name | Description |
|---|---|
| <~ | Is less than, comparison of two signals |
| >~ | Is greater than, comparison of two signals |
| trunc~ | Truncate fractional signal values |