Houdini 18.5 Nodes TOP nodes

Filter by State TOP node

Filters upstream work items by their state

On this page
Since 18.5

This node filters upstream work items by their cook state. It creates a new work item for each upstream item that matches the state filter. No new work items are created for upstream items that do not match the filter.

Unlike most nodes in TOPs, this node can generate from failed work items when the Work Item States parm is configured to include them. You can use it to do additional processing of failed work items or filter out work items that were loaded from cache files on disk.

TOP Attributes

itemlog

string

If Store Log Path is set to As Attribute the node will save the upstream work items' log paths to this attribute. The path is set to an empty string if the upstream work item has no log file.

You can configure the name of this attribute by changing the Log Path Attribute field to a different attribute name.

itemstate

integer

If the Set State Attribute parameter is on, then the node writes the upstream state value to an integer attribute on each work item. This makes it possible for downstream processing to access the state value.

You can configure the name of this attribute by changing the Set State Attribute field to a different attribute name.

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.

Operation

Determines whether the work items that match the Work Item States should be kept or discarded.

Work Item States

The work item states that the node should filter.

Store Log Path

Specifies how the upstream work items' log file paths are store to the items produced by this node.

Log Path Attribute

If Store Log Path is set to As Attribute, this parameter determines the name of the attribute used when saving the log path to work items in this node.

Set State Attribute

Examples

FilterByState Example for Filter by State TOP node

This example file demonstrates how the Filter by State node can be used to filter out failed work items.

See also

TOP nodes