GeoMask

The GeoMask node allows you to specify prims to affect. GeoMask pulls from primary input pipe, and when connected to other nodes downstream, the Mask is pushed onwards to the node below it.

To learn more about the workflow, see Using Masks Downstream.

Inputs and Controls

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

Control (UI)	Knob (Scripting)	Default Value	Function
GeoMask Tab
Mask	mask_patterns	Custom	Specifies the mask pattern to match the prim names to affect. You can use standard glob-style variables, such as /, to create masks or use individual prim names separated by spaces. For example, /GeoCube1 /GeoCard3 applies the transform to only those prims. Default - Injected/Empty* - 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.

Control (UI)

Knob (Scripting)

Default Value

Function

GeoMask Tab

Mask

mask_patterns

Custom

Specifies the mask pattern to match the prim names to affect.

You can use standard glob-style variables, such as /*, to create masks or use individual prim names separated by spaces. For example, /GeoCube1 /GeoCard3 applies the transform to only those prims.

Default - Injected/Empty - 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.