Difference between revisions of "FIFO DAT"
(TD Editor) |
(cleaning) (Tag: 2018.28070) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Summary | {{Summary | ||
| − | | | + | |opFamily=DAT |
| − | | | + | |opLicense=Non-Commercial |
| − | | | + | |opLabel=FIFO |
|long=The FIFO DAT maintains a user-set maximum number of rows in a table. You add rows using the <code>appendRow()</code> method found in [[DAT Class]]. When its capacity is reached, the first row is removed. After the maximum number of rows is reached, the oldest row is discarded when a new row is added. | |long=The FIFO DAT maintains a user-set maximum number of rows in a table. You add rows using the <code>appendRow()</code> method found in [[DAT Class]]. When its capacity is reached, the first row is removed. After the maximum number of rows is reached, the oldest row is discarded when a new row is added. | ||
| − | Example: | + | Example: |
| − | + | <syntaxhighlight lang=python>op('fifo1').appendRow(['a','b','c'])</syntaxhighlight> | |
| − | < | + | |opType=fifo |
| − | | | + | |opClass=fifoDAT_Class |
| − | | | + | |opFilter=False |
| − | | | ||
|short=The FIFO DAT maintains a user-set maximum number of rows in a table. | |short=The FIFO DAT maintains a user-set maximum number of rows in a table. | ||
}} | }} | ||
{{ParameterPage | {{ParameterPage | ||
|items= | |items= | ||
| − | {{ | + | {{Parameter|opFamily=DAT |
| − | + | |parName=callbacks | |
| − | | | + | |parLabel=Callbacks DAT |
| − | | | + | |parOrder=0 |
| − | | | + | |opType=fifo |
| − | | | + | |parSummary=The Callbacks DAT will execute once for each row added to the FIFO DAT. |
| − | | | + | |parType= |
| − | }} | + | |parReadOnly= |
| − | {{ | + | |parItems= |
| − | + | }} | |
| − | | | + | {{Parameter|opFamily=DAT |
| − | | | + | |parName=executeloc |
| − | | | + | |parOrder=1 |
| − | | | + | |parLabel=Execute from |
| − | | | + | |opType=fifo |
| − | {{ | + | |parItems= |
| − | + | {{ParameterItem|opFamily=DAT | |
| − | | | + | |parName=executeloc |
| − | | | + | |itemLabel=Current Node |
| − | | | + | |itemSummary=The script is executed from the current node location (for example, where 'cc' points to). |
| − | | | + | |itemName=current |
| − | }} | + | }}<!-- |
| − | + | -->{{ParameterItem|opFamily=DAT | |
| − | + | |parName=executeloc | |
| − | | | + | |itemLabel=Callbacks DAT |
| − | | | + | |itemSummary=The script is executed from the location of the DAT specified in the <span class="tipTextDAT">Callbacks DAT</span> parameter. |
| − | | | + | |itemName=callbacks |
| − | | | + | }}<!-- |
| − | }} | + | -->{{ParameterItem|opFamily=DAT |
| − | + | |parName=executeloc | |
| − | + | |itemLabel=Specified Operator | |
| − | | | + | |itemSummary=The script is executed from the operator specified in the <span class="tipTextDAT">From Operator</span> parameter below. |
| − | | | + | |itemName=op |
| − | | | ||
| − | | | ||
}} | }} | ||
| − | | | + | |parSummary=Determines the location the script is run from. |
| − | }} | + | |parType= |
| − | {{ | + | |parReadOnly= |
| − | + | }} | |
| − | | | + | {{Parameter|opFamily=DAT |
| − | | | + | |parName=fromop |
| − | | | + | |parLabel=From Operator |
| − | | | + | |parOrder=2 |
| − | | | + | |opType=fifo |
| − | }} | + | |parSummary=The operator whose state change will trigger the DAT to execute its script when <span class="tipTextDAT">Execute</span> is set to <span class="tipTextDAT">Specified Operator</span>. This operator is also the path that the script will be executed from if the <span class="tipTextDAT">Execute From</span> parameter is set to <span class="tipTextDAT">Specified Operator</span>. |
| − | {{ | + | |parType= |
| − | + | |parReadOnly= | |
| − | | | + | |parItems= |
| − | | | + | }} |
| − | | | + | {{Parameter|opFamily=DAT |
| − | | | + | |parName=clamp |
| − | | | + | |parLabel=Clamp Output |
| − | }} | + | |parOrder=3 |
| − | {{ | + | |opType=fifo |
| − | + | |parSummary=The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited. | |
| − | | | + | |parType= |
| − | | | + | |parReadOnly= |
| − | | | + | |parItems= |
| − | | | + | }} |
| − | | | + | {{Parameter|opFamily=DAT |
| − | }} | + | |parName=maxlines |
| − | {{ | + | |parLabel=Maximum Lines |
| − | + | |parOrder=4 | |
| − | | | + | |opType=fifo |
| − | | | + | |parSummary=Limits the number of messages, older messages are removed from the list first. |
| − | | | + | |parType= |
| − | | | + | |parReadOnly= |
| − | | | + | |parItems= |
| − | }} | + | }} |
| − | {{ | + | {{Parameter|opFamily=DAT |
| − | + | |parName=clear | |
| − | | | + | |parLabel=Clear Output |
| − | | | + | |parOrder=5 |
| − | | | + | |opType=fifo |
| − | | | + | |parSummary=Deletes all lines except the heading. To clear with a python script <syntaxhighlight lang=python inline>op('opname').par.clear.pulse()</syntaxhighlight> |
| − | | | + | |parType= |
| − | }} | + | |parReadOnly= |
| + | |parItems= | ||
| + | }} | ||
| + | {{Parameter|opFamily=DAT | ||
| + | |parName=firstrow | ||
| + | |parLabel=Keep First Row | ||
| + | |parOrder=6 | ||
| + | |opType=fifo | ||
| + | |parSummary=Keeps first row in table. | ||
| + | |parType= | ||
| + | |parReadOnly= | ||
| + | |parItems= | ||
| + | }} | ||
| − | | | + | |opFamily=DAT |
| − | | | + | |pageName=FIFO |
| − | | | + | |pageSummary= |
}} | }} | ||
{{:DAT Generator Common Page | {{:DAT Generator Common Page | ||
| Line 104: | Line 113: | ||
}} | }} | ||
{{DATNavBox | {{DATNavBox | ||
| − | | | + | |opFamily=DAT |
}} | }} | ||
{{#invoke:Category | {{#invoke:Category | ||
|list|DATs}} | |list|DATs}} | ||
Latest revision as of 18:46, 24 January 2019
Summary[edit]
The FIFO DAT maintains a user-set maximum number of rows in a table. You add rows using the appendRow() method found in DAT Class. When its capacity is reached, the first row is removed. After the maximum number of rows is reached, the oldest row is discarded when a new row is added.
Example:
op('fifo1').appendRow(['a','b','c'])
Parameters - FIFO Page
Callbacks DAT callbacks - The Callbacks DAT will execute once for each row added to the FIFO DAT.
Execute from executeloc - ⊞ - Determines the location the script is run from.
- Current Node
current- The script is executed from the current node location (for example, where 'cc' points to).
- Callbacks DAT
callbacks- The script is executed from the location of the DAT specified in the Callbacks DAT parameter.
- Specified Operator
op- The script is executed from the operator specified in the From Operator parameter below.
From Operator fromop - The operator whose state change will trigger the DAT to execute its script when Execute is set to Specified Operator. This operator is also the path that the script will be executed from if the Execute From parameter is set to Specified Operator.
Clamp Output clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.
Maximum Lines maxlines - Limits the number of messages, older messages are removed from the list first.
Clear Output clear - Deletes all lines except the heading. To clear with a python script op('opname').par.clear.pulse()
Keep First Row firstrow - Keeps first row in table.
Parameters - Common Page
Language language - ⊞ - Select how the DAT decides which script language to operate on.
- Input
input- The DAT uses the inputs script language.
- Node
node- The DAT uses it's own script language.
Edit/View Extension extension - ⊞ - Select the file extension this DAT should expose to external editors.
- dat
dat- various common file extensions.
- From Language
language- pick extension from DATs script language.
- Custom Extension
custom- Specify a custom extension.
Custom Extension customext - Specifiy the custom extension.
Word Wrap wordwrap - ⊞ - Enable Word Wrap for Node Display.
- Input
input- The DAT uses the inputs setting.
- On
on- Turn on Word Wrap.
- Off
off- Turn off Word Wrap.
TouchDesigner Build:
| DATs |
|---|
| • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • |
An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.
Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.
