line~
Linear signal ramp generator
Description
Use the line~ object to generate a signal ramp or envelope. It uses the Max time format syntax; envelope times can be either single valued fixed or tempo-relative.
Discussion
The line~ object is sample-accurate when Scheduler in Audio Interrupt is enabled. More details here.
Arguments
initial-value[float or int]
optional
Sets an initial value for the signal output. The default value is 0 .
Attributes
maxpoints[int]
Specify the maximum number of user defined points allowed in the line. The default is 129 points.
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]
JS Painter File
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: The number is the target value, to be arrived at in the time specified by the number in the right inlet. If no time has been specified since the last target value, the time is considered to be 0 and the output signal jumps immediately to the target value.
In right inlet: The number is the time, in milliseconds, in which the output signal will arrive at the target value.
- target-value/delta-time
[int]
float
In left inlet: The number is the target value, to be arrived at in the time specified by the number in the right inlet. If no time has been specified since the last target value, the time is considered to be 0 and the output signal jumps immediately to the target value.
In right inlet: The number is the time, in milliseconds, in which the output signal will arrive at the target value.
- target-value/delta-time
[float]
list
In left inlet: The first number specifies a target value and the second number specifies a total amount of time (in milliseconds) in which line~ should reach the target value. In the specified amount of time, line~ generates a ramp signal from its current value to the target value.
line~ accepts up to 128 target-time pairs in a list, to generate compound ramps. (An example would be 0 1000 1 1000 , which would go from the current value to 0 in a second, then to 1 in a second.) Once one of the ramps has reached its target value, the next one starts. A subsequent list , float , or int in the left inlet clears all ramps yet to be generated.
A list consisting of a number, followed by a comma and up to 128 target-time pairs, will set an initial value for the ramp. An example would be 0, 1 1000 which would set an initial value of 0, a new value of 1, and a target time of 1000 ms.
In right inlet: A list may be used to specify time in one of the Max time formats.
- target-value
[float]
- delta-time
[number]
anything
In left inlet: The first number specifies a target value and the second number specifies a total amount of time (in milliseconds) in which line~ should reach the target value. In the specified amount of time, line~ generates a ramp signal from its current value to the target value.
line~ accepts up to 128 target-time pairs in a list, to generate compound ramps. (An example would be 0 1000 1 1000 , which would go from the current value to 0 in a second, then to 1 in a second.) Once one of the ramps has reached its target value, the next one starts. A subsequent list , float , or int in the left inlet clears all ramps yet to be generated.
A list consisting of a number, followed by a comma and up to 128 target-time pairs, will set an initial value for the ramp. An example would be 0, 1 1000 which would set an initial value of 0, a new value of 1, and a target time of 1000 ms.
In right inlet: A list may be used to specify time in one of the Max time formats.
- target-value
[float]
- delta-time
[number]
pause
In left inlet: Pauses the internal ramp but does not change the target value nor clear pending target-time pairs. line~ will continue outputting whatever value was its current value when the pause message was received, until either it receives a resume message or until a new ramp is input.
resume
In left inlet: Resumes the internal ramp and subsequent pending target-time pairs if the line~ object was paused as a result of the pause message.
stop
In left inlet: Stops the internal ramp and clears pending target-time pairs. line~ will continue outputting whatever value was its current value when the stop message was received, resetting its target value to that value.
Output
bang
Out right outlet: When line~ has finished generating all of its ramps, bang is sent out.
signal
Out left outlet: The current target value, or a ramp moving toward the target value according to the currently stored value and the target time.
See Also
| Name | Description |
|---|---|
| adsr~ | ADSR envelope generator |
| click~ | Create an impulse |
| curve~ | Exponential ramp generator |
| line | Generate timed ramp |
| transport | Control a clock |
| zigzag~ | Linked list function editor |