|On this page|
USD collections can specify their contents with a combination of "includes" and "excludes". The contents of the collection is the prims that match the includes and don’t match any excludes. This lets you sometimes write a broad "include", and then "carve out" the prims you don’t want with "excludes".
By default, this node does not show UI for exclude rules. Turn on Add exclusions to show a separate parameter for specifying a set of prims to exclude.
Create Primitive If Required
If the primitive at Primitive path doesn’t exist, the node will create it. (The node creates a primitive with no defined Type.)
Default Primitive Path
The default primitive on which to author the collections. This parameter is referenced by default by the individual Primitive path parameters for each collection. The value of this parameter is automatically set to the value of the Collection Primitive Path preference when this node is created.
Number of Collections
The number of collections to create or modify.
Turn off this option to turn off an individual collection edit without losing the parameter values that define it.
The primitive to author the collection attribute on. This parameter can be left blank, in which case no USD collection will be authored.
The name of the collection to create/edit. This parameter can be left blank, in which case no USD collection will be authored.
Add to Last Modified Primitives
Turn on this option to have the members of this collection added to this node’s set of last modified primitives. This set of primitives is not recorded on the USD stage, but can be accessed by following LOP node using expression functions or HOM. Even if no USD collection is authored, the last modified primitives can still be affected by these parameters.
A path to an icon or image file that should be associated with the collection in the Scene Graph Tree’s collections panel. This icon path is stored in a the custom data dictionary of the collection’s include relationship.
Whether to include descendants of selected prims in the collection.
Only paths in the includes (and not in the excludes) belong to the collection. (
All the prims at or below the includes (and not under the excludes) belong to the collection. (
Expand Primitives and Properties
Like "Expand Primitives", but also includes all properties on all matched prims.
According to the Pixar documentation: "We're still not quite sure what the use cases are for this, but you can use it to capture a whole lot of UsdObjects very concisely.""
Allow Instance Proxies in Collection
Instance proxies are prims under instanceable primitives. Since they are inside instances, they are not editable, so it usually doesn’t make sense to add them to collections.
However in some cases, such as material binding, it is possible to refer to instance proxy prims. In those limited cases, it may be useful to be able to put instance proxy prims in collections. (Per-instance material bindings are not currently supported by the rendering framework, but they will be at some point.)
The primitive(s) the node should operate on. You can drag primitives from the scene graph tree pane into this textbox to add their paths, or click the Reselect button beside the text box to select the primitives in the viewer, or ⌃ Ctrl-click the Reselect button to choose prims from a pop-up tree window. You can also use primitive patterns for advanced matching, including matching all prims in a collection (using
Show another primitive pattern parameter for specifying primitives for the collection’s exclusion relationship. During composition, USD removes primitives from the exclude relationship from the list of prims in the include relationship to get the final collection contents. If this option is off, the exclude relationship for the collection is unchanged by this node.
Using the same format as the Primitives parameter, specify a set of primitives that should be explicitly excluded from the collection.