On this page | |
Since | 18.0 |
You can use this node to generate work items within the range defined by the Value Range parameter. You can set the range by frame, index, or a custom attribute value. If this node has input work items, then it will also generate work items within the range for each input.
TOP Attributes
|
float |
When Set Range Attribute is on, the node writes the range values to a float attribute on each work item and adds a |
Parameters
Generate When
Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.
All Upstream Items are Generated
This node will generate work items once all of the input nodes have generated their work items.
All Upstream Items are Cooked
This node will generate work items once all of the input nodes have cooked their work items.
Each Upstream Item is Cooked
This node will generate work items each time a work item in an input node is cooked.
Automatic
The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.
Specify Range As
Determines how the range of values if defined.
Value Range
The range is defined using a start, end and step value.
Custom Range
The range is defined using a Value Pattern. The pattern can contain multiple disjoint ranges, but can only consist of numeric values and ranges.
Value Range
When Specify Range As is set to Value Range, this parameter defines the start, end, and step size for the range of values used to generate work items.
Custom Range
When Specify Range As is set to Custom Range, this parameter can be set to a Value Pattern that defines the range of values.
Store Value As
Determines how each range value should be stored on the generated work items.
Work Item Frame
The value is set as the work item’s frame value. The range step size is saved as the work item’s frame step.
Work Item Index
The value is set as the work item’s index. Only choose this option if the step size and range values are integers.
Custom Attribute
The value is stored to a custom attribute as specified by the Attribute Name parameter.
Attribute Name
Specifies the name of the attribute in which the value should be stored.
This parameter is only available when Store Value As is set to Custom Attribute.
Set Range Attribute
When on, the node writes the range values to a float attribute on each work item and adds a range
attribute to each work item.
This attribute is useful when you're using this node as the input to a
ROP Fetch node. ROP Fetch nodes that are operating in batch mode will use the
range
attribute when generating batches. If downstream ROP Fetch nodes are generating batches from work items in this node, turn on this parameter.
Examples
RangeGenerate Example for Range Generate TOP node
This example file demonstrates how the Range Generate TOP can be used to generate a list of work items over a frame range.
See also |