clip Reference

Limit numbers to a certain range

clip

Examples

Numbers are always kept within the specified range

Arguments

minimum [number]

Optional

The minimum value is the lower limit to the range of output values allowed. If only one argument is present, it is used as both the minimum and maximum limit. If no argument is present, the minimum and maximum limit is 0.

maximum [number]

Optional

The maximum value is the upper limit to the range of output values allowed. If only one argument is present, it is used as both the minimum and maximum limit. If no argument is present, the minimum and maximum limit is 0.

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]

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]
The number is sent out the outlet, constrained within the minimum and maximum limits specified by the minimum and maximum limits. The clip object adapts the clipped output values to its input, so an integer input value will output an integer value regardless of the numeric type specified as an argument.

float

Arguments

input [float]
The number is sent out the outlet, constrained within the minimum and maximum limits. The clip object adapts the clipped output values to its input, so a floating point input value will output a floating point value regardless of the numeric type specified as an argument.

list

Arguments

input [list]
Each number in the list is constrained within the minimum and maximum limits, and the constrained numbers are sent out as a list.

set

Arguments

minimum/maximum [list]
The word set, followed by two numbers, resets the minimum and maximum limits.

Output

float

If the received number is a float, it is constrained within the specified minimum and maximum limits, then sent out the outlet as a float.

int

When an int is received in the inlet, it is constrained within the specified minimum and maximum limits, then sent out the outlet. If the received number is less than the minimum limit, the minimum value is sent out; if the received number is greater than the maximum limit, the maximum value is sent out.

list

When a list is received in the inlet, each number is constrained within the specified minimum and maximum limits, and the numbers are sent out as a list.

See Also

Name Description
Working with Video in Jitter Working with Video in Jitter
maximum Output the highest value
minimum Output the smallest value
split Look for a range of numbers
< Compare numbers for less than condition
<= Compare numbers as less than or equal to
> Compare numbers for greater than condition
>= Compare numbers for greater than or equal to condition