Viz Artist User Guide

Version 5.1 | Published October 31, 2023 ©

Docking and Workspaces

The Viz Artist interface is composed of several windows (docks), which are organized into workspaces. Each workspace is a different collection of docks which are laid out at specific positions and sizes on the screen. Placing docks on multiple monitors is supported, so that screen real estate can be maximized for individual windows like the Scene Editor.

The position, size, and behavior of docks can be customized to create window layouts that work best for individual editing workflows. These custom layouts can be saved as named workspaces and you can then switch between layouts with a single command. For example, a layout for animating and a layout for scripting, and easily switching between them by using the Workspaces menu at the top left of the main user interface window.

Workspaces Menu

The Workspaces menu contains a set of predefined workspaces with saved layouts for the most common workflows in Viz Artist, a list of available docks and an option to manage workspaces.

images/download/attachments/120735427/image2023-6-5_14-25-2.png

  • Default: Opens the default workspace of Viz Artist.

  • Views: Opens a workspace containing all views, the Scene Editor, Stage and Container/Camera/Light/Scene docks.

  • Stage: Opens a workspace containing the Scene Tree, the Scene Editor, Stage and Container/Camera/Light/Scene docks.

  • Scripting: Opens a workspace with a large area dedicated to Script editing.

  • 3.x: Opens a workspace resembling the Viz Artist version 3 layout.

Manage Workspaces

images/download/thumbnails/120735427/image2020-4-9_15-21-22.png images/download/thumbnails/120735427/image2020-4-9_15-26-54.png

  • Restore Workspace: Resets the workspace to the startup defaults.

  • Revert Workspace: Resets the workspace to hardcoded default values.

  • Save Workspace As...: Saves current layout as a new layout.

  • Manage Workspaces...: Brings up a dialog containing all existing workspace and allows to delete a user-created workspace. Default workspaces can not be deleted and are always available.

List of Available Docks

images/download/attachments/120735427/image2023-5-4_9-35-42.png

This menu contains all available docks of the Viz Artist user interface, which can be toggled by selecting the corresponding item. Visible and active docks are indicated with a check mark.

Working with Docks

Each dock contains several user interface elements to control its appearance.

images/download/attachments/120735427/image2023-3-20_9-18-46.png

  • 1: A tab to detach the dock, allowing it to be dragged around and dropped into a new position.

  • 2: Integrated documentation, click on it to open the documentation window showing the related information.

  • 3: A button to detach the dock and put it into its own floating window.

  • 4: A close button to close the entire group of docks.

Clicking and holding the mouse button on the tab (1) detaches the dock into its own floating window and displays a positioning helper widget.

images/download/thumbnails/120735427/image2019-8-12_11-22-18.png

These controls allow the dock being dragged to be placed to the north, east, south, and west of the dock under the current mouse position. By selecting the center item, the dock is placed as a new tab in the same group. If none of these controls are selected for the dock being dragged, the dock stays in its own floating window, which can be placed anywhere on the screen, even on a separate monitor. Once a dock is in floating window state, these position controls can be brought up again by clicking and dragging the window title bar.

Tip: When a dock in floating window state is closed, it can be reopened using the List of available Docks menu item in the Workspaces menu.

Help icon is currently only available on docked windows.

Documentation

Starting with Viz Artist 5.1, the offline documentation is integrated into the Artist User interface. Open the documentation on any doc by clicking on the help icon:
images/download/thumbnails/120735427/image2023-3-20_9-9-38.png
The documentation window jumps to the desired location, depending from where the help was opened.

The documentation window allows to browse within following documents (if installed):

  • Viz Artist Documentation

  • Viz Engine Administrator Guide

  • Viz Plugin Documentation

Information: The plugin web-based documentation is installed by Viz Artist.

images/download/attachments/120735427/image2023-3-20_9-12-22.png

Use the top bar to switch between the various documents:
images/download/attachments/120735427/image2023-3-20_9-14-16.png

Open externally starts your default browser and opens the current document.

Render Views

Individual Render Windows can be created. They can be used for Adaptive Scene Design to display more than one format at the same time. They can also be used to show different camera shots in traditional three-dimensional scenes. To create a new Render Window, select the Workspace Menu and Render Views.

images/download/thumbnails/120735427/image2022-6-28_10-4-48.png

Click Add Render View to create a new view, click on an existing one to open it or use the trash bin icon to delete it. Render Views are docking windows, therefore they can either be used as floating windows or be docked into your working environment.

Examples

images/download/attachments/120735427/image2022-6-28_10-8-6.png

images/download/attachments/120735427/image2022-6-28_14-6-59.png

Note: Picking is not supported in Render Views.