capture
Store values to view or edit
Description
Stores items in the order they are received for viewing, editing, and saving.
Arguments
maximum[int]
optional
The first argument sets a maximum number of items to store. If there is no argument, capture will store up to 512 items. Once the maximum has been exceeded, the earliest stored item is dropped as each new item is received.
display-format[symbol]
optional
If the second argument is a , all items will be displayed in ASCII form in the editing window. If the second argument is x , all numbers will be displayed in hexadecimal form in the editing window. If the second argument is m , numbers less than 128 are displayed in decimal, and numbers greater than 128 are in hexadecimal. If there is no argument, all items are displayed in decimal.
Attributes
listout[int]: 0
When enabled, the capture object will dump its contents as a list. Otherwise the object sends its contents one item at a time. Default = 0.
precision[int]: 4
Floating-point precision to use when printing floating-point numbers to the capture object's window. Default = 4.
size[atom_long]: 512
The maximum number of items which can be stored in the capture object's internal buffer. When resized, the object will attempt to retain the existing captured data. If the current capture position is already greater than the new size (if the buffer size is reduced), it will be reset to 0. Default = 512.
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
Numbers or symbols are stored in the order in which they are received.
- input
[int]
float
Numbers or symbols are stored in the order in which they are received.
- input
[float]
list
All numbers and/or symbols in the list are stored in order from first to last.
- input
[list]
anything
All numbers and/or symbols are stored in order from first to last.
- input
[list]
clear
Erases the contents of a capture object.
count
Sends the number of items collected since the last count message out the right outlet of the capture object. Upon receipt of the count message, the object's internal count will be reset to 0 unless flag is set.
- flag
[int]
(mouse)
Double-clicking on the object in a locked patcher will open a window which displays all values stored internally.
dump
Outputs the contents of the capture object, one item at a time, out the left outlet.
open
wclose
Closes the window associated with the capture object.
write
The word write , followed by a symbol, saves the contents of the capture object into a text file, using the symbol as the filename.
- filename
[symbol]
Output
int
Out right outlet: The number of items received since last count message was received is sent out the right outlet in response to a count message.
int, float, symbol
Out left outlet: The captured contents are sent out the left outlet, one at a time, in response to the dump message.
Double-clicking on capture (when the patcher window is locked) opens an editing window in which the stored numbers can be viewed and edited. Editing the window does not actually alter the contents of capture, but is useful for cutting and pasting values into a table or a separate file. (Although capture can continue to store items while the editing window is open, the editing window is not updated. It must be closed and reopened to view the newly stored items.)
See Also
| Name | Description |
|---|---|
| itable | Data table editor |
| text | Format messages as a text file |