Viz Artist User Guide

Version 3.13 | Published March 28, 2019 ©

Mask Source and Mask Target

With the Mask (Source and Target) plug-in one Container can act as a mask for other Containers. The Mask Container is called the source and the Containers which are affected by the source mask are called targets. A Container affected by a mask becomes transparent where the mask covers it.

Due to graphics hardware limitations, currently Viz Artist supports a maximum of eight different target and source layers for one object. This means that any target within a layer is affected by all masks for the same layer. For example, if a mask has the layers 1, 2 and 3 selected, it affects all targets that have 1, 2 or 3 selected.

Enable shadows in the Global Settings Panel:

Layers 7 and 8 may not be available because global shadow settings are enabled by default. Shadows use two layers of the mask plug-in, but can be set to Off in Global Settings Panel, to use all eight layers.

In the Global Settings Panel, define if a mask layer is to be drawn inverted. Normally the mask cuts a hole in the mask target where it covers it. If a layer is selected to be drawn inverted the opposite situation is the case. Only where the mask covers the mask target is target be visible.

Note: This plug-in is located in: Built Ins -> Container plug-ins -> Global

Mask Source and Mask Target Properties


  • Layer: Sets the layer the mask should have an effect on. This allows the creation of more than one mask that has an effect on the target

  • Inherited: (Mask Source Only) When enabled (On), all Sub-Containers of the mask source mask the target. If disabled (Off) all Sub-Containers of the mask source does not mask the target as it no longer inherits the mask properties.

  • Force Visible: (Mask Source Only) When enabled (On), the geometry serving as mask source is rendered in the scene editor, even when not selected. When disabled (Off), the mask source geometry is only rendered when selected. This enables the designer to work more efficiently with multiple mask sources when designing the scene. The mask source geometry never gets rendered on the output.

To Add a Mask


  1. Add three Containers to the Scene Tree.

  2. Name them source_1, source_2 and target.

  3. Add a Font and the Mask Source plug-in to the source_1 Container.

  4. Add a Rectangle and the Mask Source plug-in to the source_2 group.

  5. Add a Rectangle, material (e.g. red) and the Mask Target plug-in to the target Container.

  6. Open the source_1 Transformation Editor:

    1. Set Axis Center X and Y to C.

    2. Reset Position X and Y to 0.0.

  7. Open the source_1 Text Editor: Enter some text (e.g. Vizrt).

  8. Open the source_1 Mask Source editor: Set Layer to 1.

  9. Open the source_2 Transformation Editor: Set Position X to -120.0 and Y to -70.0.

  10. Open the source_2 Rectangle editor: Set Width and Height to 50.0.

  11. Open the source_2 Mask Source editor: Set Layer to 2.

  12. Open the target Rectangle editor: Set Width to 300.0 and Height to 200.0.

  13. Open the target Mask Target editor. Enable Layer 1 and Layer 2.

    1. images/download/attachments/50614896/plugins_container_mask-not-inherited.png
  14. Add a Container as a Sub-Container of source_2.

  15. Name it source_inherited.

  16. Add a Circle to the source_inherited Container.

  17. Open the source_inheritedTransformation Editor: Set Position X to 240.0.

  18. Open the source_inherited Circle editor: Set Radius to 25.0.

    1. images/download/attachments/50614896/plugins_container_mask-inherited.png
  19. Open the source_2 Mask Source editor

    1. Disable Inherited (Off). This should make the Circle disappear as it no longer inherits the Mask Source properties.