Documentation Center

Viz Artist User Guide

Version 5.1 | Published October 31, 2023 ©

Plug-ins

In Plug-ins, there are a standard set of Viz Artist installation plug-ins. Most plug-ins can be added to Working with Containers, except, for example, Scene plug-ins. Because Viz Artist uses an open interface for the plug-ins, new geometries can either be obtained or created and then installed with Viz Artist. Also, most plug-ins have a properties editor. When a plug-in is applied to a Container in the Scene Tree, a plug-in icon is added to the target Container.

The drop-down button gives access to the various plug-ins:

  • Geometry plug-ins

  • Container plug-ins

  • Classic Shader plug-ins (Classic Render Pipeline only)

  • Viz Engine Shader plug-ins (Viz Engine Render Pipeline only)

  • Scene plug-ins

  • Media Assets

images/download/attachments/85891176/image2020-4-7_8-0-53.png

The search field on the bottom of the Plugin panel allows to do a free text search for all kind of plug-ins. For example, if you want to add a Rectangle plug-in, simply start typing Rect and only plug-ins with rect in their name are displayed.

This section contains information on the following procedures:

Plug-in Context Menu

A right-click on a plug-in icon to open the plug-in context menu.

Geometry, Container, Classic Shader and Viz Engine Shader Menu

images/download/attachments/85891176/image2020-4-7_8-5-0.png

  • Add to Container(s): Adds the selected plug-in to a Container(s).

  • Add as Favourite: Adds the selected Texture to the Plug-in Overlay.

  • Delete from Favourites: Deletes the selected Texture from the Plug-in Overlay.

Scene Menu

images/download/attachments/85891176/image2020-4-7_8-7-43.png

  • Add to Scene: Adds the selected plug-in to a Scene.

  • Remove from Scene: Removes the selected plug-in from a Scene.

Media Asset Menu

images/download/attachments/85891176/image2021-8-9_17-0-46.png

  • Add <Media Asset> as Texture: Adds the selected Media Asset to a Scene (automatically adds a new Container).

  • Add <Media Asset> as DVE: Adds the selected source as DVE.

  • Add as Hybrid: Some Medi Assets (like Live inputs) can be used as DVE and Texture at the same time.

  • Show settings of <Media Asset>: Shows the settings of the Media Asset, if it has been added to the scene and the Scene Tree is in Texture or DVE view.

  • Add as Favourite: Adds the selected source to the Plug-in Overlay.

  • Delete from Favourites: Deletes the selected source from the Plug-in Overlay.

For the Background and Foreground media assets, the context menu shows the Favorite options only.

View and Search for Plug-ins

All plug-ins can be dragged straight into the Scene Tree (except Scene plug-ins). Double-click a folder tab to go to the Default folder for that plug-in category.

To View Plug-ins

  1. Select Plugins.

  2. Select the appropriate plug-in category, either:

    • From the drop-down menu that shows above the plug-ins view, or

    • Click on of the tabs.

The All folder in the left panel, offers an uncategorized view of all plug-ins. Pressing a letter on the keyboard to jump to a plug-in which starts with that letter.

To Search for a Plug-in

You can drag plug-ins from the search results to the desired destination.

  1. Select Plugins.

  2. Enter a search string. Results narrow as you type.

    images/download/attachments/85891176/v4_meb_msta.png

Add Plug-ins to Containers

The quickest way to add a plug-in to a container is to use the Plugin Overlay Panel.
images/download/thumbnails/85891176/image2022-9-20_16-42-51.png

For more details please see Plug-in Overlay.

images/download/attachments/85891176/image2022-11-29_10-39-22.png
Most plug-ins can be dragged to a target Container(s) in the scene tree (1), the Properties Panel (2) or the Scene Editor (3). Each plug-in also has a context menu where a plug-in can also be added to a Scene.

To Add a Geometry Plug-in

A Container can only contain one Geometry plug-in at a time. If a new Geometry plug-in is added, the fist one is removed from the Container.

  1. Drag the Geometry plug-in icon to either:

    • A Container or multi selected Containers.

    • The scene tree area (creates its own container).

    • The Scene Editor area.

    • The Container Editor area.
      or

  1. Highlight the target Container(s).

  2. Right-click the plug-in icon and select Add to Container(s) from the plug-in context menu.

To Add a Container Plug-in

  1. Drag the Container plug-in icon to either:

    • A Container or multi selected Containers.

    • An object in the Scene Editor (only some container plug-ins do this, when they do, the object becomes active when the icon is moved over the object).

    • The Container Editor area.
      or

  1. Highlight the target Container(s).

  2. Right-click the plug-in icon and select Add to Container(s) from the plug-in context menu.

To Add a Classic Shader Plug-in

A Container can only contain one Classic Shader at a time. If a new Classic Shader is added, the fist one is removed from the Container.

  1. Drag the icon to either:

    • A Container or multi selected Containers.

    • An object in the Scene Editor.

    • The Container Editor area.
      or

  1. Highlight the target Container(s).

  2. Right-click the plug-in icon and select Add to Container(s) from the plug-in context menu.

IClassic Shaders are only supported in the Classic Render Pipeline.

To Add a Viz Engine Shader Plug-in

Viz Engine Shaders work the same way as old Classic Shaders, but are only available in the Viz Engine Render Pipeline.

Information: Viz Engine Shaders are only supported in Viz Engine Render Pipeline.

To Add a Scene plug-in

  1. Right-click the Scene plug-in icon to open the plug-in context menu.

  2. Click on Add to Scene...

To Add a Plug-in to Multiple Containers

  1. Highlight the required Containers.

  2. Drag a plug-in icon to a highlighted Container.

  3. Release the plug-in icon.

    or

  1. Drag a plug-in icon.

  2. Hold the plug-in icon over a Container.

  3. Continue to hold the left-click and do a right-click to drop the plug-in icon on the Container.

  4. Continue to hold the left-click and repeat for each required Container.

To Add a Plug-in to Favorites

  1. Right-click the icon to open the plug-in context menu.

  2. Click Add as favorite...


You can also add plug-ins as favorites from the search panel.

To Open a Plug-in Properties Editor

Click on the Media Asset icon, in the Container or the in the Properties Editor.

See Also