ramp~
Trigger a Single Ramp With an Audio Signal
Description
The ramp~ object generates a single signal ramp between a start and end value when it detects a change in an audio signal connected to its left inlet. The duration of the ramp can be a fixed value or based on the signal in ramp~ 's second inlet.
Arguments
duration[float]
optional
If a float argument to ramp is present, it sets the initial value of the duration attribute. If a signal is connected to the second inlet, the duration attribute value is ignored in favor of the value of the signal.
Attributes
curve[float]
The curve attribute sets the parameters of the exponential function that generates the non-linear output. It can range between -1 and 1. For ascending ramps, values of curve less than 1 produce values above the linear input and values of curve greater than 1 produce values below the linear input. As curve values near -1 or 1, the curavture becomes more extreme.
duration[float]
Sets the duration of the ramp in milliseconds. The ramp object uses this value only when a signal is not connected to the second inlet.
end[float]
Set the final value of the ramp.
interval[int]
The curved output is a piecewise linear approximation of the exponential function. The interval attribute sets the number of samples used for each line segement. Values of interval must be a power of 2 between 2 and 64 samples. Larger values will produce a less accurate approximation but could be more efficient. If the signal vector size is less than interval, the actual segment length will be the signal vector size.
Possible values:
'2'
(
2 sample segment length
)
'4'
(
4 sample segment length
)
'8'
(
8 sample segment length
)
'16'
(
16 sample segment length
)
'32'
(
32 sample segment length
)
'64'
(
64 sample segment length
)
mode[int]
Sets whether the duration of the ramp is recomputed if the value of the signal connected to the second (duration) inlet changes.
Possible values:
0 = 'Set Duration at Start'
(
Duration is set at the start of the ramp and remains constant
)
1 = 'Update Duration Continuously'
(
Duration can change if the signal value connected to the right inlet changes.
)
The total duration of the ramp is recomputed to take into account the elapsed time. For example, if the original ramp was 1000 ms, and the duration signal changes to 1500 ms after the ramp has been going for 400 ms, the ramp will continue for another 1100 ms. In this case the slope of the ramp will be reduced so it takes the extra time to reach the end value.
reset[int]
Sets whether the value of the ramp resets to zero after it completes (reset equal to 1) or remains at the end value (reset equal to 0).
retrigger[int]
When retrigger is set to 0 (off), it is not possible to retrigger a ramp while a current ramp is in progress. When set to 1 (on), you may retrigger a ramp during the current ramp. The default value is 0 (off).
start[float]
Set the initial value of the ramp.
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
Converted to float
float
In left or second inlet: sets the ramp duration (only used if no signal is connected to the second inlet)
In third inlet: Sets the ramp start value
In right inlet: Sets the ramp end value
signal
A signal connected to the left inlet triggers the ramp when it goes from zero to non-zero
A signal connected to the second inlet sets the ramp duration
A signal connected the third inlet sets the ramp start value
A signal connected the right inlet sets the ramp end value
See Also
| Name | Description |
|---|---|
| click~ | Create an impulse |
| line~ | Linear signal ramp generator |
| mc.snowphasor~ | Control a Population of Phasors |
| rate~ | Time-scale the output of a phasor~ |
| phasor~ | Generate sawtooth signals |
| pong~ | Variable range signal folding |
| trapezoid~ | Trapezoidal wavetable |
| triangle~ | Triangle/ramp wavetable |
| zigzag~ | Linked list function editor |