Documentation Center

Viz Plug-ins User Guide

Version 5.1 | Published December 12, 2023 ©

Clipper

images/download/thumbnails/105098202/ico_clipper.png
The Clipper plug-in is an alternative to the mask function. Objects with the clipper plug-in attached that are placed behind the clipper plane and are masked/clipped. If an object is only partially behind a clipper plane, only the parts of the object that are behind the plane are clipped out, since the clipping is done in true 3D space. The function uses the OpenGL clipping planes. Up to six of them may be used. To define a clipper plane use the Properties Panel.

images/download/attachments/105098202/image2022-9-22_15-14-52.png
All the containers that you want to be affected by the clipping plane, you must have the clipper plug-in applied and thereafter in the editor specify which of the clipping plane is to mask out/clip the container. It is possible to let a container be affected by multiple clipping planes.

The clipper plug-in can replace mask in many situations. Some of the advantages are compared to normal mask are:

  • Clipping is done in true 3D space, while masking is done in 2D (although the 2D mask is created by a 3D object).

  • There is no performance hit. In fact there is even a performance gain if parts of the object are clipped. Regular masks have a quite high performance cost.

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

Clipper Properties

  • Planes: Enables the planes. By default, 1 is enabled.

To Create a Clipping Plane Effect


images/download/attachments/105098202/image2022-9-22_15-13-50.png

  1. Add two group containers to the scene tree (same level) and name them Cylinder and ClipperRectangle.

  2. Add the following to the Cylinder container:

    • Cylinder geometry plug-in

    • Clipper container plug-in

    • Material

    • Optional: Expert container plug-in

  3. Add the following to the ClipperRectangle container:

    • Rectangle geometry plug-in

    • Material

    • Optional: Expert container plug-in

  4. Open the editor for the Cylinder container and set Scaling (locked) to 2.0.

  5. Open the Cylinder editor and set Hole to 45.0.

  6. Open the Clipper editor and enable Plane 1 (enabled by default).

  7. Optional: Open the Expert editor(s) and enable Back Face (On) and Twosided Lighting.

  8. Open the editor for the ClipperRectangle and set the following parameters for the following properties:

    • Set Position Y to 45.0.

    • Set Rotation X to -45.0.

    • Set Rotation Y to 45.0.

    • Set Scaling (locked) to 2.0.

      images/download/attachments/105098202/image2022-9-22_15-15-22.png

  9. Open Scene Settings, and select the Clipper Panel tab.

  10. Enable State 1, and Reverse.

    images/download/thumbnails/105098202/image2022-9-22_15-15-53.png

  11. Drag and drop the ClipperRectangle container onto the Tracking Object drop zone.