zigzag~
Linked list function editor
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.
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
initial-value[int or float]
optional
Sets an initial value (y) for the zigzag~ object.
Attributes
loopmode[int]
The word loopmode , followed by 1, turns on looping. loopmode 0 turns off looping. By default, looping is off. loopmode 2 turns on looping in "pendulum" mode, in which the value and time pairs are traversed in an alternating forward and reverse direction. By default, looping is off
Possible values:
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]
mode specifies the way that the zigzag~ object responds to messages and signal values.
mode 0 (default): When the zigzag~ object receives a bang , 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 bangdelta message. The default value for bangdelta is 0 . 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 speed , loopmode , start , and end messages are ignored.
mode 1: behavior is exactly the same as in mode 0 in terms of the effect of a bang . 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 bang 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 bangdelta message. The default value for bangdelta is 0 . 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 bang 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]: 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
In left inlet: The zigzag~ object responds to a bang message according to its mode of behavior, which is set using the mode message.
If the zigzag~ object is set to mode 0 or mode 1, a bang 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 bang 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
In left inlet: Converted to float.
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.)
- output-rate-coefficient
[int]
float
In left inlet: Each element in the zigzag~ object's linked list is a pair that consists of a target value (y), followed by a second number that specifies a total amount of time in milliseconds (delta-x). In that amount of time, numbers are output regularly in a line from the current index value to the target value. The list 0 0 3.5 500 10 1000 describes a line which begins with a value of 0 at time 0, rises to a value of 3.5 a half second later, and rises again to a value of 10 in 1 second.
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).
- output-rate-coefficient
[number]
list
Sets and triggers a function as (value) (ramp-time) pairs to define points in a ramp. Sending a list message will immediately trigger the ramp.
- index and event-pair
[list]
append
The word append, followed by a list, will add new (value) (ramp-time) pairs to the end of the current list. Sending an append message will immediately trigger a ramp only made of the new points.
- value
[number]
- transition-time
[number]
bangdelta
In left inlet: The word bangdelta , followed by a float or int , specifies the time over which the transition between values occurs when the zigzag~ object receives a bang . The default is 0 (i.e., and immediate transition).
- transition-time
[number]
bound
In left inlet: The word bound , followed by two numbers which specify start and end indices (where 0 is the first element), sets the start and end points of the zigzag~ object's linked list.
- start-index
[int]
- end-index
[int]
delete
In left inlet: The word delete , followed by an int which specifies a position (where 0 is the first element), will delete the value and time pair associated with that index from the list. A list can follow the delete message if you want to remove multiple event pairs from the list. The message delete 0 will remove the current first value and time pair from the list; the second value and time pair (i.e. the value and time pair at index 1) will now become the first values in the list.
- index
[int/list]
dump
In left inlet: The word dump will cause a list consisting of all currently stored value and time pairs in the form
index value delta-x
to be sent out the zigzag~ object's 3rd outlet.
end
In left inlet: The word end , followed by an int which specifies a position (where 0 is the first element), sets the point at which the zigzag~ object ceases its output when triggered by a bang .
- end-index
[int]
insert
In left inlet: The word insert , followed by an int which specifies a position (where 0 is the first element) and a list, will insert new event pair(s) before the index specified. The message insert 0 5 500 will create a new first entry in the linked list (at the 0 index) with a value of 5 and a time of 500 milliseconds.
- index and event-pair
[list]
jump
In left inlet: The word jump , followed by an int which specifies a position (where 0 is the first element), skips to that point in the linked list and begins outputting value and time pairs from that point. An optional int can be used to specify the time, in milliseconds, over which the transition to the next value will occur (the default value is 0 ).
- index and transition-time
[list]
jumpend
In left inlet: The word jumpend causes the zigzag~ object to immediately jump forward to the last value (y)on the linked list.
- transition-time
[number]
jumpstart
In left inlet: The word jumpstart causes the zigzag~ object to immediately jump to the first value (y)on the linked list and then output the currently selected list or selected portion of the list.
- transition-time
[number]
line
next
In left inlet: The word next skips to the next value and time pair in the linked list. An optional int can be used to specify the time over which the transition to the next value will occur (the default value is 0 ).
- transition-time
[number]
prev
In left inlet: The word prev skips to the previous value and time pair in the linked list. An optional int can be used to specify the time over which the transition to the previous value will occur (the default value is 0 ).
- transition-time
[number]
print
In left inlet: The word print causes the current status and contents of the zigzag~ object to be printed out in the Max Console. The output consists of the current mode, loopmode, the start, end, and loop length of the current list, the pendulum state, and moving value of the object, followed by a listing of each index in the linked list, along with its y and delta-x values.
ramptime
In left inlet: The word ramptime , followed by a number, sets the ramp time, in milliseconds, at which the output signal will arrive at the target value.
- transition-time
[number]
set
Prepending the word set to user-defined value and ramptime messages allows for setting zigzag~ ramps without triggering playback.
- index
[int]
- value
[number]
- transition-time
[number]
setindex
In left inlet: The word setindex , followed by an int which specifies a position (where 0 is the first element) and a pair of floats, sets the target value (y) and transition time amounts (delta-x) for the specified position in the list.
- index
[int]
- value
[number]
- transition-time
[number]
setline
The word setline followed by a list of breakpoints in line~ format (as output by the function object) defines a ramp for zigzag~ without triggering it. In order to trigger the ramp, a bang needs to be sent to the first inlet. The list should consist of alternating value, time pairs.
- breakpoints
[list]
signal
In left inlet: The zigzag~ object responds to signal values according to its mode of behavior, which is set using the mode message.
If the zigzag~ object is set to mode 0 , the current index of the list is determined by the input signal value; any previously set speed , loopmode , start , and end messages will be ignored.
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 bang were received.
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 bang 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
In left inlet: The word skip , followed by a positive or negative number, will skip the specified number of indices in the zigzag~ object's linked list. Positive number values skip forward, and negative values skip backward. An optional integer can be used to specify the time over which the transition to the next or previous value will occur (the default value is 0 ).
- number-of-skipped-indices and transition-time
[list]
speed
In left inlet: The word speed , followed by a positive or negative floating-point number, specifies the rate at which the value and time pairs will be output. The message speed 1.0 traverses the list forward at normal speed, speed -1 traverses the list backwards, speed .5 traverses the linked list at half the normal speed (effectively doubling the delay time values).
- output-rate
[number]
start
In left inlet: The word start , followed by an int which specifies a position (where 0 is the first element), sets the point at which the zigzag~ object begins its output when triggered by a bang .
- start-index
[number]
stop
Sending the stop message causes the ramp to stop at the current position.
Output
bang
Out right outlet: When looping, a bang message is sent out when the loop (re-trigger) point is reached. A bang is also sent out when zigzag~ has finished generating all of its ramps.
list
Out 3rd outlet: In response to the dump message, a list consisting of all currently stored value and time pairs in the form
index value (y) delta-x
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 |