| On this page |
This node generates a work item for a range of frames, based on a file pattern.
For example, if the Frame Range is set to 1,10,1 and the pattern is set to $HIP/render/$HIPNAME.$OS.$F4.exr, the node will generate up to 10 work items.
See the pattern parameter for an explanation of the pattern syntax.
This node has two modes for generating work items:
Whenever this node is asked to generate items (when it cooks, or when you ask nodes to pre-generate static items), the node checks if the pattern matches different files from the last cook, and also if the modification times have changed on any files. If so, it updates and marks dirty the changed items. So if the directory contents change, normally only the changed items need to recook.
TOP Attributes
When Split Results into Separate Items is on, the node sets the following attributes on each work item.
|
|
string |
The directory containing the matched file. |
|
|
string |
The extension of the file associated with the work item. |
|
|
string |
The name of file, including the extension. |
|
|
int |
When Missing Files is set to Create Work Items , this attribute will be added and set to 1 if the file exists, and 0 if it doesn’t. |
Parameters
Work Item Generation
Whether this node generates static or dynamic work items. You should generally leave this set to "Automatic" unless you know the node’s work items can be computed statically, or that they need to be generated dynamically.
Dynamic
This node always creates dynamic work items: it waits until the upstream work items are known, and generates new work items from the upstream work items.
Static
This node always creates static work items: it creates the number of work items it thinks it needs based on the parameters (and any upstream static items) before the network runs.
Automatic
If the input is static (a static processor, or a partitioner with only static inputs, or a mapper), this node generates static work items, otherwise it generates dynamic work items.
Frame Range
The start, end and step size of the frame range to generate.
File Pattern
Match file paths against this pattern. The pattern allows wildcards such as ? (match any character), * (match any string of characters), and [abc] (match any one of the characters inside the square brackets). For example, *.png matches any file that ends with .png. $F, $FF, $F4 are also supported.
Missing Files
What to do when a file is not matched.
Ignore: Do not generate work items for missing files.
Set Node Error: Sets an error on the node.
Create Work Items: Creates a work item for the missing file, and sets an attribute indicating that it is missing.
File Exists Attribute
The name of the Int attribute to be added to work items. The value will be 1 if the file exists and 0 if it doesn’t.
Output File Tag
Assign this file tag to the output file paths. If this is off, the node guesses appropriate file tags based on filename extensions.
