image-20240919-115628.png

The Window Mask plug-in limits the area into which a Sub-Container of Window Mask is rendered to a user-defined rectangular section of the output.

It is possible to add a tracking object. If a tracking object is used, it’s bounding box is projected onto the screen and the resulting rectangle is used as a mask.

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

Window Mask Properties

  • Position X, Position Y: Specifies the upper left corner of the rectangle. The values are scaled in such a way that (0,0) refers to the upper left and (100,100) to the bottom right corner of the screen.

  • Width, Height: Specifies the dimensions of the rectangle in percentages of the screen dimensions.

  • Tracking: Provides an alternative to setting the position and dimensions by a bounding box of a particular container.

    • Origin: Specifies where to take a container as a tracking object. Apart from Custom, three neighborhoods of the container holding Window Mask are available:

      • Previous: Adjacent container above as shown in the scene tree.

      • Next: Adjacent container below as shown in the scene tree.

      • First Child: Adjacent child container as shown in the scene tree.

    • Object: Specifies a container from the scene tree to be a tracking object. The specified container is taken into consideration if and only if Origin is set to Custom. To discard the specified container, click on Reset.

Note: The underlying mask operation is integral. Use other masks like Mask Source / Mask Target if you need subpixel accuracy.

To Use the Window Mask

  1. Add a Rectangle geometry to the scene tree, and add material to it.

  2. Open the Rectangle editor and set Width to 200.0.

  3. Open the transformation editor and set Position Y to -36.

  4. Add a new group, and add the Window Mask plug-in to it.

  5. Add a Sphere geometry as a Sub-Container of the group container, and add material to it.

  6. Open the Window Mask editor, activate Tracking, drag, and drop the Rectangle container onto the Object drop zone. This should give you a sphere that is partly masked due to the rectangle object.