GeoPrune

The GeoPrune node is used to show and hide objects in the scene or deactivate and active objects in the scene. Hide causes the specified objects to become invisible, whereas deactivate causes the specified objects to behave as though they haven't been added to the scene at all.

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

GeoPrune

Mask

mask_patterns

All roots

Specifies the mask pattern to match the prim names to affect. The default mask, All roots, defaults to select the top most level Xforms in your scene graph.

You can use standard glob-style variables, 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.

All roots - select 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.

Invert Selection

invert_mask

off

When turned off the prune method is only applied to the objects specified in the Mask control.

When turned on, the prune method is applied to all objects in the scene not specified in the Mask control.

Method

method

Hide

Sets the prune method to apply to objects:

Hide - hides the objects specified by the Mask pattern. Hidden objects behave as if they are invisible.

Show - shows the objects specified by the Mask pattern.

Deactivate - deactivates the objects specified by the Mask pattern. Deactivated objects behave as if they were never added to the scene.

Activate - Activates the objects specified by the Mask pattern. Activated objects behave normally.