Houdini 19.0 HScript commands viewmaskoverlay

viewmaskoverlay HScript command

Sets various options of the view mask overlay in viewports.

On this page

viewmaskoverlay [-o opacity] viewport [viewport2 ...]

Options

-o opacity

Set the opacity of the overlay.

How to refer to viewers and viewports in commands

Viewers have names with the form “desk.pane.type”, where:

  • desk = The name of the desk containing the viewer pane.

  • pane = The name of the viewer pane.

  • type = “world”, “particle”, or “texture”, depending on the contents of the pane.

To see a list of all viewers, use “viewls -n”. For most viewer-related commands, you can specify more than one viewer at a time, and/or use wildcards in viewer names.

A viewer can be subdivided into up to four viewports (such as top, left, front, and perspective). Viewports have names with the form “desk.pane.type.viewport”, where:

  • desk = The name of the desk containing the viewer pane.

  • pane = The name of the viewer pane.

  • type = “world”, “particle”, or “texture”, depending on the contents of the pane.

  • viewport = The name of the viewport within the viewer pane. You can change the name of a viewport in the viewport’s display options editor. To list all viewports, use “viewls -n -v” (to show what viewer each viewport is in, just use “viewls -v”).

For most viewport-related commands, you can specify more than one viewer at a time, and/or use wildcards in viewer names. You can also use the name of a viewer to refer to all viewports in the viewer. For example instead of "viewcamera -c cam1 Build.panetab1.world.persp1 Build.panetab1.world.top1 ...", you could do "viewcamera -c cam1 Build.panetab1.world.*" or just "viewcamera -c cam1 Build.panetab1.world".

Most viewport-related commands work on view-memories as well as viewports. View-memories have the format "desk.pane.type:memory", where memory is a number from 1-9 or a name. The first three components (desk name, pane name, type) can have wildcards. To list all view-memories, use viewls -n -l.

The viewlayout command controls the number and layout of viewports in a viewer pane.

Examples

viewmaskoverlay -o 0.4 *
viewmaskoverlay -o 0.7 Build.panetab1.world

viewmaskoverlay