| Since | 17.5 |
Parameters ¶
Generate Static Work Items
Generates static work items in all nodes in the TOP network. None of the work items will be cooked, and dynamic nodes will do nothing.
Note
You can add cook controls for any TOP network to any node. For more information, see Adding TOP network cook controls to any node.
Checkpoint Format
Determines the graph checkpoint format. By default the graph uses a JSON-based file format, however the deprecated Python file format is still supported for loading old task graph files.
Save Graph Attributes to .hip
When on, all the global attributes stored on the graph are saved to its .hip file. This makes it so that when you next open the .hip, the global attributes will still be available on the graph.
JSON Checkpoint Format
Checkpoint File
Specifies the path to the JSON file to save/load. This is used by Load Checkpoint button and is the file that the network auto saves to when Checkpoint Rate is enabled.
Load Checkpoint
Dirties the TOP network and loads the JSON checkpoiint file specified by the Checkpoint File parameter.
Load Checkpoint
Determines whether or not the checkpoint file should be loaded automatically when the scene is loaded.
Checkpoint Rate
When enabled, TOPs saves graph checkpoints to disk at regular intervals. The checkpoint rate is specified in work item operations. For example, the default rate of 10 saves the graph every time 10 works items are created, modified, or have their state changed. A final checkpoint is always written out when the graph finishes cooking. When this parameter is disabled checkpoints are not written to disk.
Python Checkpoint Format
Save Checkpoint
Saves the state of all work items in the TOP network to an external file. You can then restore with thestate with the Load Checkpoint button. The task graph is saved to the path specified by the Checkpoint File parameter.
Load Checkpoint
Dirties the TOP network and loads the task graph file specified by the Task Graph File parameter.
Checkpoint File
Specifies the path to the task graph cache file to save/load. This is used by Save Checkpoint and Load Checkpoint buttons, and it is where the network auto saves to when Auto-Save Rate is turned on.
Checkpoint Rate
When on, TOPs saves the task graph to disk at regular intervals. The save rate is specified in seconds. For example, the default rate of 10 saves the graph every 10 seconds. This can be useful when you want to checkpoint a large graph in its fully-cooked state.
Default TOP Scheduler
Specifies the default scheduler node that is used by all TOP nodes in the network, unless a TOP node has its own Scheduler override.
This can be a relative node path. As such, since your Schedulers are most likely at the main level of the network (and not inside a subnet), you can just use the Scheduler’s node name. For example, localscheduler or hqueuescheduler.
Default Item Label
When on, specifies the label that is assigned to any work item in the TOP network that was generated by a Processor with the Use Default Label setting.
On Node Recook
Determines what happens to work items when a node is recooked after it has been modified. By default, PDG will regenerate work items in the node, which updates their attribute values to match the parameters and invalidates existing output caches.
Update Work Items and Invalidate Caches
The default behavior. When a TOP node recooks, its work items are updated to match the parameters on the node. Work items that are modified in the process then have their output files invalidated.
Update Work Items Only
Attributes on work items are updated to match the parameters on the node, but the output cache files are not invalidated.
Ignore Changes
Nodes are not automatically recooked. Work items are left as-is unless the node is explicitly dirtied.
Evaluation Time
Determines what time value is used when evaluating parameters in the TOP network without an active work item. If a parameter is evaluated against a particular work item, the work item’s frame will determine the parameter’s evaluation time.
Network Cook Time
Parameters are evaluated using the time value that was set when the TOP network first began to cook. Changes to the current time while the network is cooking will not affect parameter evaluation.
Global Start Time
Parameters are evaluated using the global start frame/time value, regardless of the current evaluation time.
Custom
Parameters are evaluated at the custom time value specified by the Custom Time parameter.
Custom Time
Specifies the time value to use when evaluating parameters in the TOP network without an active work item.
This parameter is only available when Evaluation Time is set to Custom.
Save Scene File if Required
When this parameter is enabled, PDG will save the current .hip file before cooking if there are unsaved changes and work items in the graph use the scene file. Otherwise, if this parameter is disabled, the scene file will never be saved automatically.
A dialog will be displayed before the scene is saved, however the dialog also an option to make the selection the default use it for future cooks.
