click~
Create an impulse
Description
Use the click~ to create and output an impulse which can be used as an impulse-trigger.
Discussion
The click~ object is sample-accurate when Scheduler in Audio Interrupt is enabled. More details here.
Arguments
wavetable-values[list]
optional
A list of floating-point values in the range 0.0-1.0, can be used to specify an impulse (i.e., a small wavetable) whose length is determined by the number of list elements. The maximum size for the list is 256 items.
Attributes
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
bang
Sends an impulse out the click~ object's outlet. The default impulse consists of a single value (1.0), followed by zero values.
int
Sends an impulse scaled by the value of the number.
- scale
[int]
float
Sends an impulse scaled by the value of the number. The default impulse consists of a the value of the input number followed by zero values. If an impulse wavetable has been defined with the set message, the values in the table will be scaled by the input.
- scale
[float]
set
The word set , followed by a list of floating-point values in the range 0.0-1.0, specifies a impulse (i.e., a small wavetable) whose length is determined by the number of list elements. The maximum size for the list is 256 items.
- wavetable-values
[list]
signal
A signal will trigger clicks on zero to non-zero transitions.
Output
signal
An impulse.
See Also
| Name | Description |
|---|---|
| buffer~ | Store audio samples |
| buffir~ | buffer-based FIR filter |
| line~ | Linear signal ramp generator |