zigzag~
Description
Use zigzag~ to generate multisegment linear ramps. This object is similar to line~, but retains information about the ramp after it has been output, and allows modification of the list values for the ramp.
Examples
Discussion
The zigzag~ object uses a linked list implementation rather than the line~ object's stack-based implementation, which does not retain information after it has been output. In addition to simply remembering the current "line", the zigzag~ object lets you modify the list by inserting, deleting, or appending points.
Each element in the zigzag~ object's linked list has a value (y), and a transition time value (delta-x), which specifies the amount of time over which the transition from one value to another will occur. When zigzag~ contains a list, this list can be triggered (the starting and ending points can be set and changed), traversed forwards or backwards at different speeds, and looped. The current position in the list can be jumped to, and also held.
Arguments
Attributes
loopmode [int]
The word
0 = 'No Loop'
(
looping off
)
1 = 'Forward'
(
forward looping on
)
2 = 'Palindrome'
(
palindrome looping
)
maxpoints [int]
Specifies the number of user-defined points for ramps. The defualt value is 2048.
mode [int]
zigzag~ object responds to messages and signal values.
mode 0 (default): When the zigzag~ object receives a , it will jump to the start point (or end point if our direction is negative) and begin outputting values from there. The time value associated with this jump has its length defined by the message. The default value for is . If a signal is connected to the left inlet of the zigzag~ object in this mode, the current index of the list is determined by the signal; any previously set , , , and messages are ignored.
mode 1: behavior is exactly the same as in mode 0 in terms of the effect of a . In mode 1, signal inputs are handled differently. If a signal is connected to the left inlet of the zigzag~ object in mode 1, the input signal functions as a trigger signal; when the slope of the input signal changes from non-negative to negative, the object will be re-triggered as though a were received.
mode 2: jump to the next index in the list (or the previous index, if the current direction is negative) and begin outputting values from there. The time value associated with this jump has its length defined by the message. The default value for is . If a signal is connected to the left inlet of the zigzag~ object in mode 2, the input signal functions as a trigger signal; when the slope of the input signal changes from non-negative to negative, the object will be re-triggered as though a were received.
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.
adds the object to the background layer, 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
bang
If the zigzag~ object is set to mode 0 or mode 1, a message will cause the zigzag~ object to go to the start point (or end point if the direction is negative) and begin outputting values from there.
If the zigzag~ object is set to mode 2, a message will cause the zigzag~ object to jump to the next index in the list (or the previous index, if the current direction is negative) and begin outputting values from there.
int
Arguments
In right inlet: Specifies the rate at which the value and time pairs will be output. A value of 1.0 traverses the list forward at normal speed. A playback rate of -1 traverses the list backwards (i.e. in reverse). A value of .5 traverses the linked list at half the normal speed (effectively doubling the delay time values).
(In left inlet: Converted to float.)
float
Arguments
In right inlet: Specifies the rate at which the value and time pairs will be output. A value of 1.0 traverses the list forward at normal speed. A playback rate of -1 traverses the list backwards (i.e. in reverse). A value of .5 traverses the linked list at half the normal speed (effectively doubling the delay time values).
list
Arguments
append
Arguments
transition-time [number]
bangdelta
Arguments
bound
Arguments
end-index [int]
delete
Arguments
dump
will cause a list consisting of all currently stored value and time pairs in the formend
Arguments
insert
Arguments
jump
Arguments
jumpend
Arguments
jumpstart
Arguments
line
Arguments
next
Arguments
prev
Arguments
ramptime
Arguments
set
Arguments
value [number]
transition-time [number]
setindex
Arguments
value [number]
transition-time [number]
setline
Arguments
signal
If the zigzag~ object is set to , the current index of the list is determined by the input signal value; any previously set , , , and messages will be ignored.
If a signal is connected to the left inlet of the zigzag~ object in , the input signal functions as a trigger signal; when the slope of the input signal changes from non-negative to negative, the object will be re-triggered as though a were received.
If a signal is connected to the left inlet of the zigzag~ object in , the input signal functions as a trigger signal; when the slope of the input signal changes from non-negative to negative, the object will be re-triggered as though a were received.
In right inlet: A signal value specifies the rate at which the value and time pairs will be output. A value of 1.0 traverses the list forward at normal speed. A playback rate of -1 traverses the list backwards (i.e. in reverse). A signal value of .5 traverses the linked list at half the normal speed (effectively doubling the delay time values). The value of the input signal is sampled once per input vector. Therefore, any periodic frequency modulation with a period which is greater than the current sample rate/(2*vector_size) will alias.
skip
Arguments
speed
Arguments
start
Arguments
stop
Output
bang
Out right outlet: When looping, a zigzag~ has finished generating all of its ramps.
message is sent out when the loop (re-trigger) point is reached. A is also sent out whenlist
Out 3rd outlet: In response to the dump message, a list consisting of all currently stored value and time pairs in the form
is output.
signal
Out 1st outlet: The current target value, or a ramp moving toward the target value according to the currently stored value and the target time.
Out 2nd outlet: The current index.
See Also
Name | Description |
---|---|
adsr~ | ADSR envelope generator |
curve~ | Exponential ramp generator |
kink~ | Distort a sawtooth waveform |
line~ | Linear signal ramp generator |