GeoCollection

The GeoCollection node creates a collection attribute on an object. Enter an object, a list of paths and a collection name, and a collection is created on the object containing the paths. This can then be used later on in a path expression as a shortcut to refer to the paths. For example, you might create collections for all the lights or cameras in the scene or any prims that have shadows cast on them.

To learn more about the workflow, see Using Collections.

Inputs and Controls

Connection Type	Connection Name	Function
Input	unnamed	The previous stage in the scene you want to affect.

Control (UI)	Knob (Scripting)	Default Value	Function
GeoCollection
Mask	mask_patterns	Default - Injected/ All Roots	Specifies the mask pattern to match the prim names to affect. You can use standard glob-style wildcards, such as '', '?', to create masks or use individual prim names separated by spaces. For example, /GeoCube 1 /GeoCard3 applies the effect to only those prims. Default - Injected/ All Roots* - selects the default prim(s) for the node. The default will be the injected mask prim paths if there is an upstream node with this. Otherwise the default mask for this node type is evaluated. All roots - selects the top level Xform(s) in your scene. Last modified - selects whatever the last node modified was. All Cameras - selects all Cameras in your scene graph. All Lights - select all lights in your scene graph. All Meshes - selects all meshes in your scene graph. Custom - sets a custom selection of prims that exist in your scene graph. Tip: You can also use the cog menu, the Viewer picker, or drag and drop paths from the Scene Graph to create masks.
Inject Mask	inject_mask	off	When enabled the mask in this node is injected into the node directly below it if that node has the default path mask set.
Collection Name	collection_name	none	Sets the name of the collection to create and authors a collection token in the USD source.
Includes	includes	none	Specifies prims to explicitly include from the collection. For example, //PointLight* adds all PointLights to the collection.
Excludes	excludes	none	Specifies prims to explicitly exclude from the collection. For example, /PointLight1 explicitly excludes PointLight1.

Collection Workflow Example

This simple example creates a cube, duplicates the cube using GeoInstance, and then passes GeoScope and GeoCollection information to a GeoVisibility to remove instances of the cube starting with /GeoCube1_3* from the scene.

Copy

Pruning Cube Duplicates by Collection

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
set cut_paste_input [stack 0]
                version 17.0 v1.398328b
                push $cut_paste_input
                GeoCube {
                setAuthorMode {double_sided set}
                setAuthorMode {display_color set}
                display_color {1 0.749311 0.020768}
                display_color_panelDropped true
                name GeoCube2
                selected true
                xpos -396
                ypos 759
                }
                GeoInstance {
                count 4
                translate {1.889999986 0 0}
                name GeoInstance1
                selected true
                xpos -396
                ypos 818
                }
                GeoInstance {
                translate {0 0 1.889999986}
                name GeoInstance2
                selected true
                xpos -396
                ypos 842
                }
                GeoScopePrim {
                prim_path /collections
                name GeoScope1
                selected true
                xpos -396
                ypos 899
                }
                GeoCollection {
                mask_patterns /collections
                collection_name cubes
                includes /GeoCube2_3*
                name GeoCollection2
                selected true
                xpos -396
                ypos 947
                }
                GeoIsolate {
                mask_patterns " %/collections:cubes"
                name GeoActivation1
                selected true
                xpos -396
                ypos 990
                }
}